From 79113f3f6843489498dfcbf2fd65e87376c2a585 Mon Sep 17 00:00:00 2001 From: Cristian Klein Date: Fri, 26 Feb 2021 10:32:30 +0100 Subject: [PATCH 001/104] Change to inclusive naming See https://inclusivenaming.org/ on why "multi-master" should be avoided. --- content/en/docs/concepts/overview/components.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/concepts/overview/components.md b/content/en/docs/concepts/overview/components.md index eb17e2dd7e..3d42d83616 100644 --- a/content/en/docs/concepts/overview/components.md +++ b/content/en/docs/concepts/overview/components.md @@ -33,7 +33,7 @@ The control plane's components make global decisions about the cluster (for exam Control plane components can be run on any machine in the cluster. However, for simplicity, set up scripts typically start all control plane components on the same machine, and do not run user containers on this machine. See -[Building High-Availability Clusters](/docs/admin/high-availability/) for an example multi-master-VM setup. +[Building High-Availability Clusters](/docs/admin/high-availability/) for an example multi-control-plane-VM setup. ### kube-apiserver From 6c60620ad437d1be284a194e2e950f2890a1c636 Mon Sep 17 00:00:00 2001 From: Sergey Kanzhelev Date: Sat, 6 Mar 2021 06:42:10 +0000 Subject: [PATCH 002/104] added note about the name being an identifier --- .../en/docs/concepts/overview/working-with-objects/names.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/content/en/docs/concepts/overview/working-with-objects/names.md b/content/en/docs/concepts/overview/working-with-objects/names.md index bc89d1c30a..a74b59c71a 100644 --- a/content/en/docs/concepts/overview/working-with-objects/names.md +++ b/content/en/docs/concepts/overview/working-with-objects/names.md @@ -24,6 +24,10 @@ For non-unique user-provided attributes, Kubernetes provides [labels](/docs/conc {{< glossary_definition term_id="name" length="all" >}} +{{< note >}} +In cases when objects represent a physical entity (like Node represent a physical host), when host is re-created under the same name without deleting and re-creating a Node, Kubernetes will treat it as a same thing, which may lead to inconsistencies. +{{< /note >}} + Below are three types of commonly used name constraints for resources. ### DNS Subdomain Names From 7a5da05b9569fe130fcc54c03e3c01b8029b4d5c Mon Sep 17 00:00:00 2001 From: Sergey Kanzhelev Date: Sat, 6 Mar 2021 07:15:20 +0000 Subject: [PATCH 003/104] add inconistency message to Nodes page as well --- content/en/docs/concepts/architecture/nodes.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/content/en/docs/concepts/architecture/nodes.md b/content/en/docs/concepts/architecture/nodes.md index 7bd4b355b6..cd2c2291c5 100644 --- a/content/en/docs/concepts/architecture/nodes.md +++ b/content/en/docs/concepts/architecture/nodes.md @@ -66,6 +66,15 @@ delete the Node object to stop that health checking. The name of a Node object must be a valid [DNS subdomain name](/docs/concepts/overview/working-with-objects/names#dns-subdomain-names). +{{< note >}} +The [name](/docs/concepts/overview/working-with-objects/names#names) identifies a Node. Two Nodes +cannot have the same name at the same time. Kubernetes also assumes that a resource with the same +name is the same object. In case of a Node, it is implicitly assumed that an instance using the +same name will have the same state (e.g. network settings, root disk contents). This may lead to +inconsistencies if instance was altered without the change of a name or deleting and re-creating the +Node object from API server. +{{< /note >}} + ### Self-registration of Nodes When the kubelet flag `--register-node` is true (the default), the kubelet will attempt to From c009ad84311c44556f4ec72aac6adec228a57615 Mon Sep 17 00:00:00 2001 From: Jihoon Seo <46767780+jihoon-seo@users.noreply.github.com> Date: Mon, 8 Mar 2021 16:17:09 +0900 Subject: [PATCH 004/104] Update href to the anchor in the same page --- content/en/docs/tutorials/hello-minikube.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/tutorials/hello-minikube.md b/content/en/docs/tutorials/hello-minikube.md index 4bd6a9a82c..ea447f0997 100644 --- a/content/en/docs/tutorials/hello-minikube.md +++ b/content/en/docs/tutorials/hello-minikube.md @@ -62,7 +62,7 @@ If you installed minikube locally, run `minikube start`. {{< note >}} The `dashboard` command enables the dashboard add-on and opens the proxy in the default web browser. You can create Kubernetes resources on the dashboard such as Deployment and Service. -If you are running in an environment as root, see [Open Dashboard with URL](/docs/tutorials/hello-minikube#open-dashboard-with-url). +If you are running in an environment as root, see [Open Dashboard with URL](#open-dashboard-with-url). To stop the proxy, run `Ctrl+C` to exit the process. The dashboard remains running. {{< /note >}} From dd2153d2dbde9b20560332252fdd1428229de372 Mon Sep 17 00:00:00 2001 From: Philippe Martin Date: Mon, 8 Mar 2021 18:59:39 +0100 Subject: [PATCH 005/104] Use consistent pluralization for API groupings in reference --- .../policies-resources/_index.md | 4 -- .../kubernetes-api/policy-resources/_index.md | 4 ++ .../limit-range-v1.md | 26 ++++----- .../network-policy-v1.md | 26 ++++----- .../pod-disruption-budget-v1beta1.md | 38 ++++++------- .../pod-security-policy-v1beta1.md | 28 +++++----- .../resource-quota-v1.md | 42 +++++++-------- .../service-resources/_index.md | 4 ++ .../endpoint-slice-v1beta1.md | 24 ++++----- .../endpoints-v1.md | 24 ++++----- .../ingress-class-v1.md | 24 ++++----- .../ingress-v1.md | 38 ++++++------- .../service-v1.md | 38 ++++++------- .../services-resources/_index.md | 4 -- .../workload-resources/_index.md | 4 ++ .../container.md | 0 .../controller-revision-v1.md | 24 ++++----- .../cron-job-v1beta1.md | 40 +++++++------- .../cron-job-v2alpha1.md | 40 +++++++------- .../daemon-set-v1.md | 40 +++++++------- .../deployment-v1.md | 40 +++++++------- .../ephemeral-container.md | 0 .../horizontal-pod-autoscaler-v1.md | 38 ++++++------- .../horizontal-pod-autoscaler-v2beta2.md | 38 ++++++------- .../job-v1.md | 40 +++++++------- .../pod-template-v1.md | 32 +++++------ .../pod-v1.md | 54 +++++++++---------- .../priority-class-v1.md | 22 ++++---- .../replica-set-v1.md | 40 +++++++------- .../replication-controller-v1.md | 40 +++++++------- .../stateful-set-v1.md | 40 +++++++------- .../workloads-resources/_index.md | 4 -- 32 files changed, 430 insertions(+), 430 deletions(-) delete mode 100644 content/en/docs/reference/kubernetes-api/policies-resources/_index.md create mode 100644 content/en/docs/reference/kubernetes-api/policy-resources/_index.md rename content/en/docs/reference/kubernetes-api/{policies-resources => policy-resources}/limit-range-v1.md (90%) rename content/en/docs/reference/kubernetes-api/{policies-resources => policy-resources}/network-policy-v1.md (93%) rename content/en/docs/reference/kubernetes-api/{policies-resources => policy-resources}/pod-disruption-budget-v1beta1.md (86%) rename content/en/docs/reference/kubernetes-api/{policies-resources => policy-resources}/pod-security-policy-v1beta1.md (91%) rename content/en/docs/reference/kubernetes-api/{policies-resources => policy-resources}/resource-quota-v1.md (86%) create mode 100644 content/en/docs/reference/kubernetes-api/service-resources/_index.md rename content/en/docs/reference/kubernetes-api/{services-resources => service-resources}/endpoint-slice-v1beta1.md (92%) rename content/en/docs/reference/kubernetes-api/{services-resources => service-resources}/endpoints-v1.md (92%) rename content/en/docs/reference/kubernetes-api/{services-resources => service-resources}/ingress-class-v1.md (87%) rename content/en/docs/reference/kubernetes-api/{services-resources => service-resources}/ingress-v1.md (93%) rename content/en/docs/reference/kubernetes-api/{services-resources => service-resources}/service-v1.md (94%) delete mode 100644 content/en/docs/reference/kubernetes-api/services-resources/_index.md create mode 100644 content/en/docs/reference/kubernetes-api/workload-resources/_index.md rename content/en/docs/reference/kubernetes-api/{workloads-resources => workload-resources}/container.md (100%) rename content/en/docs/reference/kubernetes-api/{workloads-resources => workload-resources}/controller-revision-v1.md (89%) rename content/en/docs/reference/kubernetes-api/{workloads-resources => workload-resources}/cron-job-v1beta1.md (88%) rename content/en/docs/reference/kubernetes-api/{workloads-resources => workload-resources}/cron-job-v2alpha1.md (88%) rename content/en/docs/reference/kubernetes-api/{workloads-resources => workload-resources}/daemon-set-v1.md (90%) rename content/en/docs/reference/kubernetes-api/{workloads-resources => workload-resources}/deployment-v1.md (90%) rename content/en/docs/reference/kubernetes-api/{workloads-resources => workload-resources}/ephemeral-container.md (100%) rename content/en/docs/reference/kubernetes-api/{workloads-resources => workload-resources}/horizontal-pod-autoscaler-v1.md (85%) rename content/en/docs/reference/kubernetes-api/{workloads-resources => workload-resources}/horizontal-pod-autoscaler-v2beta2.md (94%) rename content/en/docs/reference/kubernetes-api/{workloads-resources => workload-resources}/job-v1.md (91%) rename content/en/docs/reference/kubernetes-api/{workloads-resources => workload-resources}/pod-template-v1.md (86%) rename content/en/docs/reference/kubernetes-api/{workloads-resources => workload-resources}/pod-v1.md (94%) rename content/en/docs/reference/kubernetes-api/{workloads-resources => workload-resources}/priority-class-v1.md (88%) rename content/en/docs/reference/kubernetes-api/{workloads-resources => workload-resources}/replica-set-v1.md (88%) rename content/en/docs/reference/kubernetes-api/{workloads-resources => workload-resources}/replication-controller-v1.md (86%) rename content/en/docs/reference/kubernetes-api/{workloads-resources => workload-resources}/stateful-set-v1.md (89%) delete mode 100644 content/en/docs/reference/kubernetes-api/workloads-resources/_index.md diff --git a/content/en/docs/reference/kubernetes-api/policies-resources/_index.md b/content/en/docs/reference/kubernetes-api/policies-resources/_index.md deleted file mode 100644 index 251e411647..0000000000 --- a/content/en/docs/reference/kubernetes-api/policies-resources/_index.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: "Policies Resources" -weight: 6 ---- diff --git a/content/en/docs/reference/kubernetes-api/policy-resources/_index.md b/content/en/docs/reference/kubernetes-api/policy-resources/_index.md new file mode 100644 index 0000000000..06a9e27fee --- /dev/null +++ b/content/en/docs/reference/kubernetes-api/policy-resources/_index.md @@ -0,0 +1,4 @@ +--- +title: "Policy Resources" +weight: 6 +--- diff --git a/content/en/docs/reference/kubernetes-api/policies-resources/limit-range-v1.md b/content/en/docs/reference/kubernetes-api/policy-resources/limit-range-v1.md similarity index 90% rename from content/en/docs/reference/kubernetes-api/policies-resources/limit-range-v1.md rename to content/en/docs/reference/kubernetes-api/policy-resources/limit-range-v1.md index d73c4d3630..00982c5ab8 100644 --- a/content/en/docs/reference/kubernetes-api/policies-resources/limit-range-v1.md +++ b/content/en/docs/reference/kubernetes-api/policy-resources/limit-range-v1.md @@ -30,7 +30,7 @@ LimitRange sets resource usage limits for each kind of resource in a Namespace. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata -- **spec** (}}">LimitRangeSpec) +- **spec** (}}">LimitRangeSpec) Spec defines the limits enforced. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status @@ -95,7 +95,7 @@ LimitRangeList is a list of LimitRange items. Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -- **items** ([]}}">LimitRange), required +- **items** ([]}}">LimitRange), required Items is a list of LimitRange objects. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ @@ -142,7 +142,7 @@ GET /api/v1/namespaces/{namespace}/limitranges/{name} #### Response -200 (}}">LimitRange): OK +200 (}}">LimitRange): OK 401: Unauthorized @@ -215,7 +215,7 @@ GET /api/v1/namespaces/{namespace}/limitranges #### Response -200 (}}">LimitRangeList): OK +200 (}}">LimitRangeList): OK 401: Unauthorized @@ -283,7 +283,7 @@ GET /api/v1/limitranges #### Response -200 (}}">LimitRangeList): OK +200 (}}">LimitRangeList): OK 401: Unauthorized @@ -302,7 +302,7 @@ POST /api/v1/namespaces/{namespace}/limitranges }}">namespace -- **body**: }}">LimitRange, required +- **body**: }}">LimitRange, required @@ -326,11 +326,11 @@ POST /api/v1/namespaces/{namespace}/limitranges #### Response -200 (}}">LimitRange): OK +200 (}}">LimitRange): OK -201 (}}">LimitRange): Created +201 (}}">LimitRange): Created -202 (}}">LimitRange): Accepted +202 (}}">LimitRange): Accepted 401: Unauthorized @@ -354,7 +354,7 @@ PUT /api/v1/namespaces/{namespace}/limitranges/{name} }}">namespace -- **body**: }}">LimitRange, required +- **body**: }}">LimitRange, required @@ -378,9 +378,9 @@ PUT /api/v1/namespaces/{namespace}/limitranges/{name} #### Response -200 (}}">LimitRange): OK +200 (}}">LimitRange): OK -201 (}}">LimitRange): Created +201 (}}">LimitRange): Created 401: Unauthorized @@ -433,7 +433,7 @@ PATCH /api/v1/namespaces/{namespace}/limitranges/{name} #### Response -200 (}}">LimitRange): OK +200 (}}">LimitRange): OK 401: Unauthorized diff --git a/content/en/docs/reference/kubernetes-api/policies-resources/network-policy-v1.md b/content/en/docs/reference/kubernetes-api/policy-resources/network-policy-v1.md similarity index 93% rename from content/en/docs/reference/kubernetes-api/policies-resources/network-policy-v1.md rename to content/en/docs/reference/kubernetes-api/policy-resources/network-policy-v1.md index 798a3dc891..78e4868d94 100644 --- a/content/en/docs/reference/kubernetes-api/policies-resources/network-policy-v1.md +++ b/content/en/docs/reference/kubernetes-api/policy-resources/network-policy-v1.md @@ -30,7 +30,7 @@ NetworkPolicy describes what network traffic is allowed for a set of Pods Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata -- **spec** (}}">NetworkPolicySpec) +- **spec** (}}">NetworkPolicySpec) Specification of the desired behavior for this NetworkPolicy. @@ -190,7 +190,7 @@ NetworkPolicyList is a list of NetworkPolicy objects. Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata -- **items** ([]}}">NetworkPolicy), required +- **items** ([]}}">NetworkPolicy), required Items is a list of schema objects. @@ -237,7 +237,7 @@ GET /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name} #### Response -200 (}}">NetworkPolicy): OK +200 (}}">NetworkPolicy): OK 401: Unauthorized @@ -310,7 +310,7 @@ GET /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies #### Response -200 (}}">NetworkPolicyList): OK +200 (}}">NetworkPolicyList): OK 401: Unauthorized @@ -378,7 +378,7 @@ GET /apis/networking.k8s.io/v1/networkpolicies #### Response -200 (}}">NetworkPolicyList): OK +200 (}}">NetworkPolicyList): OK 401: Unauthorized @@ -397,7 +397,7 @@ POST /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies }}">namespace -- **body**: }}">NetworkPolicy, required +- **body**: }}">NetworkPolicy, required @@ -421,11 +421,11 @@ POST /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies #### Response -200 (}}">NetworkPolicy): OK +200 (}}">NetworkPolicy): OK -201 (}}">NetworkPolicy): Created +201 (}}">NetworkPolicy): Created -202 (}}">NetworkPolicy): Accepted +202 (}}">NetworkPolicy): Accepted 401: Unauthorized @@ -449,7 +449,7 @@ PUT /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name} }}">namespace -- **body**: }}">NetworkPolicy, required +- **body**: }}">NetworkPolicy, required @@ -473,9 +473,9 @@ PUT /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name} #### Response -200 (}}">NetworkPolicy): OK +200 (}}">NetworkPolicy): OK -201 (}}">NetworkPolicy): Created +201 (}}">NetworkPolicy): Created 401: Unauthorized @@ -528,7 +528,7 @@ PATCH /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name} #### Response -200 (}}">NetworkPolicy): OK +200 (}}">NetworkPolicy): OK 401: Unauthorized diff --git a/content/en/docs/reference/kubernetes-api/policies-resources/pod-disruption-budget-v1beta1.md b/content/en/docs/reference/kubernetes-api/policy-resources/pod-disruption-budget-v1beta1.md similarity index 86% rename from content/en/docs/reference/kubernetes-api/policies-resources/pod-disruption-budget-v1beta1.md rename to content/en/docs/reference/kubernetes-api/policy-resources/pod-disruption-budget-v1beta1.md index 47b9d83a7e..9120b19468 100644 --- a/content/en/docs/reference/kubernetes-api/policies-resources/pod-disruption-budget-v1beta1.md +++ b/content/en/docs/reference/kubernetes-api/policy-resources/pod-disruption-budget-v1beta1.md @@ -29,11 +29,11 @@ PodDisruptionBudget is an object to define the max disruption that can be caused - **metadata** (}}">ObjectMeta) -- **spec** (}}">PodDisruptionBudgetSpec) +- **spec** (}}">PodDisruptionBudgetSpec) Specification of the desired behavior of the PodDisruptionBudget. -- **status** (}}">PodDisruptionBudgetStatus) +- **status** (}}">PodDisruptionBudgetStatus) Most recently observed status of the PodDisruptionBudget. @@ -121,7 +121,7 @@ PodDisruptionBudgetList is a collection of PodDisruptionBudgets. - **metadata** (}}">ListMeta) -- **items** ([]}}">PodDisruptionBudget), required +- **items** ([]}}">PodDisruptionBudget), required @@ -167,7 +167,7 @@ GET /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name} #### Response -200 (}}">PodDisruptionBudget): OK +200 (}}">PodDisruptionBudget): OK 401: Unauthorized @@ -200,7 +200,7 @@ GET /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}/stat #### Response -200 (}}">PodDisruptionBudget): OK +200 (}}">PodDisruptionBudget): OK 401: Unauthorized @@ -273,7 +273,7 @@ GET /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets #### Response -200 (}}">PodDisruptionBudgetList): OK +200 (}}">PodDisruptionBudgetList): OK 401: Unauthorized @@ -341,7 +341,7 @@ GET /apis/policy/v1beta1/poddisruptionbudgets #### Response -200 (}}">PodDisruptionBudgetList): OK +200 (}}">PodDisruptionBudgetList): OK 401: Unauthorized @@ -360,7 +360,7 @@ POST /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets }}">namespace -- **body**: }}">PodDisruptionBudget, required +- **body**: }}">PodDisruptionBudget, required @@ -384,11 +384,11 @@ POST /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets #### Response -200 (}}">PodDisruptionBudget): OK +200 (}}">PodDisruptionBudget): OK -201 (}}">PodDisruptionBudget): Created +201 (}}">PodDisruptionBudget): Created -202 (}}">PodDisruptionBudget): Accepted +202 (}}">PodDisruptionBudget): Accepted 401: Unauthorized @@ -412,7 +412,7 @@ PUT /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name} }}">namespace -- **body**: }}">PodDisruptionBudget, required +- **body**: }}">PodDisruptionBudget, required @@ -436,9 +436,9 @@ PUT /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name} #### Response -200 (}}">PodDisruptionBudget): OK +200 (}}">PodDisruptionBudget): OK -201 (}}">PodDisruptionBudget): Created +201 (}}">PodDisruptionBudget): Created 401: Unauthorized @@ -462,7 +462,7 @@ PUT /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}/stat }}">namespace -- **body**: }}">PodDisruptionBudget, required +- **body**: }}">PodDisruptionBudget, required @@ -486,9 +486,9 @@ PUT /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}/stat #### Response -200 (}}">PodDisruptionBudget): OK +200 (}}">PodDisruptionBudget): OK -201 (}}">PodDisruptionBudget): Created +201 (}}">PodDisruptionBudget): Created 401: Unauthorized @@ -541,7 +541,7 @@ PATCH /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name} #### Response -200 (}}">PodDisruptionBudget): OK +200 (}}">PodDisruptionBudget): OK 401: Unauthorized @@ -594,7 +594,7 @@ PATCH /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}/st #### Response -200 (}}">PodDisruptionBudget): OK +200 (}}">PodDisruptionBudget): OK 401: Unauthorized diff --git a/content/en/docs/reference/kubernetes-api/policies-resources/pod-security-policy-v1beta1.md b/content/en/docs/reference/kubernetes-api/policy-resources/pod-security-policy-v1beta1.md similarity index 91% rename from content/en/docs/reference/kubernetes-api/policies-resources/pod-security-policy-v1beta1.md rename to content/en/docs/reference/kubernetes-api/policy-resources/pod-security-policy-v1beta1.md index 1d2eac8837..59444cbbcf 100644 --- a/content/en/docs/reference/kubernetes-api/policies-resources/pod-security-policy-v1beta1.md +++ b/content/en/docs/reference/kubernetes-api/policy-resources/pod-security-policy-v1beta1.md @@ -30,7 +30,7 @@ PodSecurityPolicy governs the ability to make requests that affect the Security Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata -- **spec** (}}">PodSecurityPolicySpec) +- **spec** (}}">PodSecurityPolicySpec) spec defines the policy enforced. @@ -331,7 +331,7 @@ PodSecurityPolicyList is a list of PodSecurityPolicy objects. Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata -- **items** ([]}}">PodSecurityPolicy), required +- **items** ([]}}">PodSecurityPolicy), required items is a list of schema objects. @@ -373,7 +373,7 @@ GET /apis/policy/v1beta1/podsecuritypolicies/{name} #### Response -200 (}}">PodSecurityPolicy): OK +200 (}}">PodSecurityPolicy): OK 401: Unauthorized @@ -441,7 +441,7 @@ GET /apis/policy/v1beta1/podsecuritypolicies #### Response -200 (}}">PodSecurityPolicyList): OK +200 (}}">PodSecurityPolicyList): OK 401: Unauthorized @@ -455,7 +455,7 @@ POST /apis/policy/v1beta1/podsecuritypolicies #### Parameters -- **body**: }}">PodSecurityPolicy, required +- **body**: }}">PodSecurityPolicy, required @@ -479,11 +479,11 @@ POST /apis/policy/v1beta1/podsecuritypolicies #### Response -200 (}}">PodSecurityPolicy): OK +200 (}}">PodSecurityPolicy): OK -201 (}}">PodSecurityPolicy): Created +201 (}}">PodSecurityPolicy): Created -202 (}}">PodSecurityPolicy): Accepted +202 (}}">PodSecurityPolicy): Accepted 401: Unauthorized @@ -502,7 +502,7 @@ PUT /apis/policy/v1beta1/podsecuritypolicies/{name} name of the PodSecurityPolicy -- **body**: }}">PodSecurityPolicy, required +- **body**: }}">PodSecurityPolicy, required @@ -526,9 +526,9 @@ PUT /apis/policy/v1beta1/podsecuritypolicies/{name} #### Response -200 (}}">PodSecurityPolicy): OK +200 (}}">PodSecurityPolicy): OK -201 (}}">PodSecurityPolicy): Created +201 (}}">PodSecurityPolicy): Created 401: Unauthorized @@ -576,7 +576,7 @@ PATCH /apis/policy/v1beta1/podsecuritypolicies/{name} #### Response -200 (}}">PodSecurityPolicy): OK +200 (}}">PodSecurityPolicy): OK 401: Unauthorized @@ -624,9 +624,9 @@ DELETE /apis/policy/v1beta1/podsecuritypolicies/{name} #### Response -200 (}}">PodSecurityPolicy): OK +200 (}}">PodSecurityPolicy): OK -202 (}}">PodSecurityPolicy): Accepted +202 (}}">PodSecurityPolicy): Accepted 401: Unauthorized diff --git a/content/en/docs/reference/kubernetes-api/policies-resources/resource-quota-v1.md b/content/en/docs/reference/kubernetes-api/policy-resources/resource-quota-v1.md similarity index 86% rename from content/en/docs/reference/kubernetes-api/policies-resources/resource-quota-v1.md rename to content/en/docs/reference/kubernetes-api/policy-resources/resource-quota-v1.md index 66b0451d2d..93b8cbc9e8 100644 --- a/content/en/docs/reference/kubernetes-api/policies-resources/resource-quota-v1.md +++ b/content/en/docs/reference/kubernetes-api/policy-resources/resource-quota-v1.md @@ -30,11 +30,11 @@ ResourceQuota sets aggregate quota restrictions enforced per namespace Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata -- **spec** (}}">ResourceQuotaSpec) +- **spec** (}}">ResourceQuotaSpec) Spec defines the desired quota. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status -- **status** (}}">ResourceQuotaStatus) +- **status** (}}">ResourceQuotaStatus) Status defines the actual enforced quota and its current usage. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status @@ -120,7 +120,7 @@ ResourceQuotaList is a list of ResourceQuota items. Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -- **items** ([]}}">ResourceQuota), required +- **items** ([]}}">ResourceQuota), required Items is a list of ResourceQuota objects. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ @@ -167,7 +167,7 @@ GET /api/v1/namespaces/{namespace}/resourcequotas/{name} #### Response -200 (}}">ResourceQuota): OK +200 (}}">ResourceQuota): OK 401: Unauthorized @@ -200,7 +200,7 @@ GET /api/v1/namespaces/{namespace}/resourcequotas/{name}/status #### Response -200 (}}">ResourceQuota): OK +200 (}}">ResourceQuota): OK 401: Unauthorized @@ -273,7 +273,7 @@ GET /api/v1/namespaces/{namespace}/resourcequotas #### Response -200 (}}">ResourceQuotaList): OK +200 (}}">ResourceQuotaList): OK 401: Unauthorized @@ -341,7 +341,7 @@ GET /api/v1/resourcequotas #### Response -200 (}}">ResourceQuotaList): OK +200 (}}">ResourceQuotaList): OK 401: Unauthorized @@ -360,7 +360,7 @@ POST /api/v1/namespaces/{namespace}/resourcequotas }}">namespace -- **body**: }}">ResourceQuota, required +- **body**: }}">ResourceQuota, required @@ -384,11 +384,11 @@ POST /api/v1/namespaces/{namespace}/resourcequotas #### Response -200 (}}">ResourceQuota): OK +200 (}}">ResourceQuota): OK -201 (}}">ResourceQuota): Created +201 (}}">ResourceQuota): Created -202 (}}">ResourceQuota): Accepted +202 (}}">ResourceQuota): Accepted 401: Unauthorized @@ -412,7 +412,7 @@ PUT /api/v1/namespaces/{namespace}/resourcequotas/{name} }}">namespace -- **body**: }}">ResourceQuota, required +- **body**: }}">ResourceQuota, required @@ -436,9 +436,9 @@ PUT /api/v1/namespaces/{namespace}/resourcequotas/{name} #### Response -200 (}}">ResourceQuota): OK +200 (}}">ResourceQuota): OK -201 (}}">ResourceQuota): Created +201 (}}">ResourceQuota): Created 401: Unauthorized @@ -462,7 +462,7 @@ PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}/status }}">namespace -- **body**: }}">ResourceQuota, required +- **body**: }}">ResourceQuota, required @@ -486,9 +486,9 @@ PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}/status #### Response -200 (}}">ResourceQuota): OK +200 (}}">ResourceQuota): OK -201 (}}">ResourceQuota): Created +201 (}}">ResourceQuota): Created 401: Unauthorized @@ -541,7 +541,7 @@ PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name} #### Response -200 (}}">ResourceQuota): OK +200 (}}">ResourceQuota): OK 401: Unauthorized @@ -594,7 +594,7 @@ PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}/status #### Response -200 (}}">ResourceQuota): OK +200 (}}">ResourceQuota): OK 401: Unauthorized @@ -647,9 +647,9 @@ DELETE /api/v1/namespaces/{namespace}/resourcequotas/{name} #### Response -200 (}}">ResourceQuota): OK +200 (}}">ResourceQuota): OK -202 (}}">ResourceQuota): Accepted +202 (}}">ResourceQuota): Accepted 401: Unauthorized diff --git a/content/en/docs/reference/kubernetes-api/service-resources/_index.md b/content/en/docs/reference/kubernetes-api/service-resources/_index.md new file mode 100644 index 0000000000..0ab511b5a4 --- /dev/null +++ b/content/en/docs/reference/kubernetes-api/service-resources/_index.md @@ -0,0 +1,4 @@ +--- +title: "Service Resources" +weight: 2 +--- diff --git a/content/en/docs/reference/kubernetes-api/services-resources/endpoint-slice-v1beta1.md b/content/en/docs/reference/kubernetes-api/service-resources/endpoint-slice-v1beta1.md similarity index 92% rename from content/en/docs/reference/kubernetes-api/services-resources/endpoint-slice-v1beta1.md rename to content/en/docs/reference/kubernetes-api/service-resources/endpoint-slice-v1beta1.md index bb8c7213bb..1ad467b022 100644 --- a/content/en/docs/reference/kubernetes-api/services-resources/endpoint-slice-v1beta1.md +++ b/content/en/docs/reference/kubernetes-api/service-resources/endpoint-slice-v1beta1.md @@ -136,7 +136,7 @@ EndpointSliceList represents a list of endpoint slices Standard list metadata. -- **items** ([]}}">EndpointSlice), required +- **items** ([]}}">EndpointSlice), required List of endpoint slices @@ -183,7 +183,7 @@ GET /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices/{name} #### Response -200 (}}">EndpointSlice): OK +200 (}}">EndpointSlice): OK 401: Unauthorized @@ -256,7 +256,7 @@ GET /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices #### Response -200 (}}">EndpointSliceList): OK +200 (}}">EndpointSliceList): OK 401: Unauthorized @@ -324,7 +324,7 @@ GET /apis/discovery.k8s.io/v1beta1/endpointslices #### Response -200 (}}">EndpointSliceList): OK +200 (}}">EndpointSliceList): OK 401: Unauthorized @@ -343,7 +343,7 @@ POST /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices }}">namespace -- **body**: }}">EndpointSlice, required +- **body**: }}">EndpointSlice, required @@ -367,11 +367,11 @@ POST /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices #### Response -200 (}}">EndpointSlice): OK +200 (}}">EndpointSlice): OK -201 (}}">EndpointSlice): Created +201 (}}">EndpointSlice): Created -202 (}}">EndpointSlice): Accepted +202 (}}">EndpointSlice): Accepted 401: Unauthorized @@ -395,7 +395,7 @@ PUT /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices/{name} }}">namespace -- **body**: }}">EndpointSlice, required +- **body**: }}">EndpointSlice, required @@ -419,9 +419,9 @@ PUT /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices/{name} #### Response -200 (}}">EndpointSlice): OK +200 (}}">EndpointSlice): OK -201 (}}">EndpointSlice): Created +201 (}}">EndpointSlice): Created 401: Unauthorized @@ -474,7 +474,7 @@ PATCH /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices/{name #### Response -200 (}}">EndpointSlice): OK +200 (}}">EndpointSlice): OK 401: Unauthorized diff --git a/content/en/docs/reference/kubernetes-api/services-resources/endpoints-v1.md b/content/en/docs/reference/kubernetes-api/service-resources/endpoints-v1.md similarity index 92% rename from content/en/docs/reference/kubernetes-api/services-resources/endpoints-v1.md rename to content/en/docs/reference/kubernetes-api/service-resources/endpoints-v1.md index b0c73533f8..ce5c582b30 100644 --- a/content/en/docs/reference/kubernetes-api/services-resources/endpoints-v1.md +++ b/content/en/docs/reference/kubernetes-api/service-resources/endpoints-v1.md @@ -144,7 +144,7 @@ EndpointsList is a list of endpoints. Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -- **items** ([]}}">Endpoints), required +- **items** ([]}}">Endpoints), required List of endpoints. @@ -191,7 +191,7 @@ GET /api/v1/namespaces/{namespace}/endpoints/{name} #### Response -200 (}}">Endpoints): OK +200 (}}">Endpoints): OK 401: Unauthorized @@ -264,7 +264,7 @@ GET /api/v1/namespaces/{namespace}/endpoints #### Response -200 (}}">EndpointsList): OK +200 (}}">EndpointsList): OK 401: Unauthorized @@ -332,7 +332,7 @@ GET /api/v1/endpoints #### Response -200 (}}">EndpointsList): OK +200 (}}">EndpointsList): OK 401: Unauthorized @@ -351,7 +351,7 @@ POST /api/v1/namespaces/{namespace}/endpoints }}">namespace -- **body**: }}">Endpoints, required +- **body**: }}">Endpoints, required @@ -375,11 +375,11 @@ POST /api/v1/namespaces/{namespace}/endpoints #### Response -200 (}}">Endpoints): OK +200 (}}">Endpoints): OK -201 (}}">Endpoints): Created +201 (}}">Endpoints): Created -202 (}}">Endpoints): Accepted +202 (}}">Endpoints): Accepted 401: Unauthorized @@ -403,7 +403,7 @@ PUT /api/v1/namespaces/{namespace}/endpoints/{name} }}">namespace -- **body**: }}">Endpoints, required +- **body**: }}">Endpoints, required @@ -427,9 +427,9 @@ PUT /api/v1/namespaces/{namespace}/endpoints/{name} #### Response -200 (}}">Endpoints): OK +200 (}}">Endpoints): OK -201 (}}">Endpoints): Created +201 (}}">Endpoints): Created 401: Unauthorized @@ -482,7 +482,7 @@ PATCH /api/v1/namespaces/{namespace}/endpoints/{name} #### Response -200 (}}">Endpoints): OK +200 (}}">Endpoints): OK 401: Unauthorized diff --git a/content/en/docs/reference/kubernetes-api/services-resources/ingress-class-v1.md b/content/en/docs/reference/kubernetes-api/service-resources/ingress-class-v1.md similarity index 87% rename from content/en/docs/reference/kubernetes-api/services-resources/ingress-class-v1.md rename to content/en/docs/reference/kubernetes-api/service-resources/ingress-class-v1.md index 121c9551eb..92ad085310 100644 --- a/content/en/docs/reference/kubernetes-api/services-resources/ingress-class-v1.md +++ b/content/en/docs/reference/kubernetes-api/service-resources/ingress-class-v1.md @@ -30,7 +30,7 @@ IngressClass represents the class of the Ingress, referenced by the Ingress Spec Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata -- **spec** (}}">IngressClassSpec) +- **spec** (}}">IngressClassSpec) 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 @@ -72,7 +72,7 @@ IngressClassList is a collection of IngressClasses. Standard list metadata. -- **items** ([]}}">IngressClass), required +- **items** ([]}}">IngressClass), required Items is the list of IngressClasses. @@ -114,7 +114,7 @@ GET /apis/networking.k8s.io/v1/ingressclasses/{name} #### Response -200 (}}">IngressClass): OK +200 (}}">IngressClass): OK 401: Unauthorized @@ -182,7 +182,7 @@ GET /apis/networking.k8s.io/v1/ingressclasses #### Response -200 (}}">IngressClassList): OK +200 (}}">IngressClassList): OK 401: Unauthorized @@ -196,7 +196,7 @@ POST /apis/networking.k8s.io/v1/ingressclasses #### Parameters -- **body**: }}">IngressClass, required +- **body**: }}">IngressClass, required @@ -220,11 +220,11 @@ POST /apis/networking.k8s.io/v1/ingressclasses #### Response -200 (}}">IngressClass): OK +200 (}}">IngressClass): OK -201 (}}">IngressClass): Created +201 (}}">IngressClass): Created -202 (}}">IngressClass): Accepted +202 (}}">IngressClass): Accepted 401: Unauthorized @@ -243,7 +243,7 @@ PUT /apis/networking.k8s.io/v1/ingressclasses/{name} name of the IngressClass -- **body**: }}">IngressClass, required +- **body**: }}">IngressClass, required @@ -267,9 +267,9 @@ PUT /apis/networking.k8s.io/v1/ingressclasses/{name} #### Response -200 (}}">IngressClass): OK +200 (}}">IngressClass): OK -201 (}}">IngressClass): Created +201 (}}">IngressClass): Created 401: Unauthorized @@ -317,7 +317,7 @@ PATCH /apis/networking.k8s.io/v1/ingressclasses/{name} #### Response -200 (}}">IngressClass): OK +200 (}}">IngressClass): OK 401: Unauthorized diff --git a/content/en/docs/reference/kubernetes-api/services-resources/ingress-v1.md b/content/en/docs/reference/kubernetes-api/service-resources/ingress-v1.md similarity index 93% rename from content/en/docs/reference/kubernetes-api/services-resources/ingress-v1.md rename to content/en/docs/reference/kubernetes-api/service-resources/ingress-v1.md index 003ad959ea..72a0383f96 100644 --- a/content/en/docs/reference/kubernetes-api/services-resources/ingress-v1.md +++ b/content/en/docs/reference/kubernetes-api/service-resources/ingress-v1.md @@ -30,11 +30,11 @@ Ingress is a collection of rules that allow inbound connections to reach the end Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata -- **spec** (}}">IngressSpec) +- **spec** (}}">IngressSpec) 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** (}}">IngressStatus) +- **status** (}}">IngressStatus) 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 @@ -274,7 +274,7 @@ IngressList is a collection of Ingress. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata -- **items** ([]}}">Ingress), required +- **items** ([]}}">Ingress), required Items is the list of Ingress. @@ -321,7 +321,7 @@ GET /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name} #### Response -200 (}}">Ingress): OK +200 (}}">Ingress): OK 401: Unauthorized @@ -354,7 +354,7 @@ GET /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status #### Response -200 (}}">Ingress): OK +200 (}}">Ingress): OK 401: Unauthorized @@ -427,7 +427,7 @@ GET /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses #### Response -200 (}}">IngressList): OK +200 (}}">IngressList): OK 401: Unauthorized @@ -495,7 +495,7 @@ GET /apis/networking.k8s.io/v1/ingresses #### Response -200 (}}">IngressList): OK +200 (}}">IngressList): OK 401: Unauthorized @@ -514,7 +514,7 @@ POST /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses }}">namespace -- **body**: }}">Ingress, required +- **body**: }}">Ingress, required @@ -538,11 +538,11 @@ POST /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses #### Response -200 (}}">Ingress): OK +200 (}}">Ingress): OK -201 (}}">Ingress): Created +201 (}}">Ingress): Created -202 (}}">Ingress): Accepted +202 (}}">Ingress): Accepted 401: Unauthorized @@ -566,7 +566,7 @@ PUT /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name} }}">namespace -- **body**: }}">Ingress, required +- **body**: }}">Ingress, required @@ -590,9 +590,9 @@ PUT /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name} #### Response -200 (}}">Ingress): OK +200 (}}">Ingress): OK -201 (}}">Ingress): Created +201 (}}">Ingress): Created 401: Unauthorized @@ -616,7 +616,7 @@ PUT /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status }}">namespace -- **body**: }}">Ingress, required +- **body**: }}">Ingress, required @@ -640,9 +640,9 @@ PUT /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status #### Response -200 (}}">Ingress): OK +200 (}}">Ingress): OK -201 (}}">Ingress): Created +201 (}}">Ingress): Created 401: Unauthorized @@ -695,7 +695,7 @@ PATCH /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name} #### Response -200 (}}">Ingress): OK +200 (}}">Ingress): OK 401: Unauthorized @@ -748,7 +748,7 @@ PATCH /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status #### Response -200 (}}">Ingress): OK +200 (}}">Ingress): OK 401: Unauthorized diff --git a/content/en/docs/reference/kubernetes-api/services-resources/service-v1.md b/content/en/docs/reference/kubernetes-api/service-resources/service-v1.md similarity index 94% rename from content/en/docs/reference/kubernetes-api/services-resources/service-v1.md rename to content/en/docs/reference/kubernetes-api/service-resources/service-v1.md index bfb2c819bd..3ed9e93d96 100644 --- a/content/en/docs/reference/kubernetes-api/services-resources/service-v1.md +++ b/content/en/docs/reference/kubernetes-api/service-resources/service-v1.md @@ -30,11 +30,11 @@ Service is a named abstraction of software service (for example, mysql) consisti Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata -- **spec** (}}">ServiceSpec) +- **spec** (}}">ServiceSpec) Spec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status -- **status** (}}">ServiceStatus) +- **status** (}}">ServiceStatus) Most recently observed status of the service. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status @@ -290,7 +290,7 @@ ServiceList holds a list of services. Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -- **items** ([]}}">Service), required +- **items** ([]}}">Service), required List of services @@ -337,7 +337,7 @@ GET /api/v1/namespaces/{namespace}/services/{name} #### Response -200 (}}">Service): OK +200 (}}">Service): OK 401: Unauthorized @@ -370,7 +370,7 @@ GET /api/v1/namespaces/{namespace}/services/{name}/status #### Response -200 (}}">Service): OK +200 (}}">Service): OK 401: Unauthorized @@ -443,7 +443,7 @@ GET /api/v1/namespaces/{namespace}/services #### Response -200 (}}">ServiceList): OK +200 (}}">ServiceList): OK 401: Unauthorized @@ -511,7 +511,7 @@ GET /api/v1/services #### Response -200 (}}">ServiceList): OK +200 (}}">ServiceList): OK 401: Unauthorized @@ -530,7 +530,7 @@ POST /api/v1/namespaces/{namespace}/services }}">namespace -- **body**: }}">Service, required +- **body**: }}">Service, required @@ -554,11 +554,11 @@ POST /api/v1/namespaces/{namespace}/services #### Response -200 (}}">Service): OK +200 (}}">Service): OK -201 (}}">Service): Created +201 (}}">Service): Created -202 (}}">Service): Accepted +202 (}}">Service): Accepted 401: Unauthorized @@ -582,7 +582,7 @@ PUT /api/v1/namespaces/{namespace}/services/{name} }}">namespace -- **body**: }}">Service, required +- **body**: }}">Service, required @@ -606,9 +606,9 @@ PUT /api/v1/namespaces/{namespace}/services/{name} #### Response -200 (}}">Service): OK +200 (}}">Service): OK -201 (}}">Service): Created +201 (}}">Service): Created 401: Unauthorized @@ -632,7 +632,7 @@ PUT /api/v1/namespaces/{namespace}/services/{name}/status }}">namespace -- **body**: }}">Service, required +- **body**: }}">Service, required @@ -656,9 +656,9 @@ PUT /api/v1/namespaces/{namespace}/services/{name}/status #### Response -200 (}}">Service): OK +200 (}}">Service): OK -201 (}}">Service): Created +201 (}}">Service): Created 401: Unauthorized @@ -711,7 +711,7 @@ PATCH /api/v1/namespaces/{namespace}/services/{name} #### Response -200 (}}">Service): OK +200 (}}">Service): OK 401: Unauthorized @@ -764,7 +764,7 @@ PATCH /api/v1/namespaces/{namespace}/services/{name}/status #### Response -200 (}}">Service): OK +200 (}}">Service): OK 401: Unauthorized diff --git a/content/en/docs/reference/kubernetes-api/services-resources/_index.md b/content/en/docs/reference/kubernetes-api/services-resources/_index.md deleted file mode 100644 index 1c4c64040d..0000000000 --- a/content/en/docs/reference/kubernetes-api/services-resources/_index.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: "Services Resources" -weight: 2 ---- diff --git a/content/en/docs/reference/kubernetes-api/workload-resources/_index.md b/content/en/docs/reference/kubernetes-api/workload-resources/_index.md new file mode 100644 index 0000000000..85d1bfa44f --- /dev/null +++ b/content/en/docs/reference/kubernetes-api/workload-resources/_index.md @@ -0,0 +1,4 @@ +--- +title: "Workload Resources" +weight: 1 +--- diff --git a/content/en/docs/reference/kubernetes-api/workloads-resources/container.md b/content/en/docs/reference/kubernetes-api/workload-resources/container.md similarity index 100% rename from content/en/docs/reference/kubernetes-api/workloads-resources/container.md rename to content/en/docs/reference/kubernetes-api/workload-resources/container.md diff --git a/content/en/docs/reference/kubernetes-api/workloads-resources/controller-revision-v1.md b/content/en/docs/reference/kubernetes-api/workload-resources/controller-revision-v1.md similarity index 89% rename from content/en/docs/reference/kubernetes-api/workloads-resources/controller-revision-v1.md rename to content/en/docs/reference/kubernetes-api/workload-resources/controller-revision-v1.md index 950e9d729c..5caea2a5d9 100644 --- a/content/en/docs/reference/kubernetes-api/workloads-resources/controller-revision-v1.md +++ b/content/en/docs/reference/kubernetes-api/workload-resources/controller-revision-v1.md @@ -88,7 +88,7 @@ ControllerRevisionList is a resource containing a list of ControllerRevision obj More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata -- **items** ([]}}">ControllerRevision), required +- **items** ([]}}">ControllerRevision), required Items is the list of ControllerRevisions @@ -135,7 +135,7 @@ GET /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name} #### Response -200 (}}">ControllerRevision): OK +200 (}}">ControllerRevision): OK 401: Unauthorized @@ -208,7 +208,7 @@ GET /apis/apps/v1/namespaces/{namespace}/controllerrevisions #### Response -200 (}}">ControllerRevisionList): OK +200 (}}">ControllerRevisionList): OK 401: Unauthorized @@ -276,7 +276,7 @@ GET /apis/apps/v1/controllerrevisions #### Response -200 (}}">ControllerRevisionList): OK +200 (}}">ControllerRevisionList): OK 401: Unauthorized @@ -295,7 +295,7 @@ POST /apis/apps/v1/namespaces/{namespace}/controllerrevisions }}">namespace -- **body**: }}">ControllerRevision, required +- **body**: }}">ControllerRevision, required @@ -319,11 +319,11 @@ POST /apis/apps/v1/namespaces/{namespace}/controllerrevisions #### Response -200 (}}">ControllerRevision): OK +200 (}}">ControllerRevision): OK -201 (}}">ControllerRevision): Created +201 (}}">ControllerRevision): Created -202 (}}">ControllerRevision): Accepted +202 (}}">ControllerRevision): Accepted 401: Unauthorized @@ -347,7 +347,7 @@ PUT /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name} }}">namespace -- **body**: }}">ControllerRevision, required +- **body**: }}">ControllerRevision, required @@ -371,9 +371,9 @@ PUT /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name} #### Response -200 (}}">ControllerRevision): OK +200 (}}">ControllerRevision): OK -201 (}}">ControllerRevision): Created +201 (}}">ControllerRevision): Created 401: Unauthorized @@ -426,7 +426,7 @@ PATCH /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name} #### Response -200 (}}">ControllerRevision): OK +200 (}}">ControllerRevision): OK 401: Unauthorized diff --git a/content/en/docs/reference/kubernetes-api/workloads-resources/cron-job-v1beta1.md b/content/en/docs/reference/kubernetes-api/workload-resources/cron-job-v1beta1.md similarity index 88% rename from content/en/docs/reference/kubernetes-api/workloads-resources/cron-job-v1beta1.md rename to content/en/docs/reference/kubernetes-api/workload-resources/cron-job-v1beta1.md index 22a0135bf8..c99aa57998 100644 --- a/content/en/docs/reference/kubernetes-api/workloads-resources/cron-job-v1beta1.md +++ b/content/en/docs/reference/kubernetes-api/workload-resources/cron-job-v1beta1.md @@ -30,11 +30,11 @@ CronJob represents the configuration of a single cron job. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata -- **spec** (}}">CronJobSpec) +- **spec** (}}">CronJobSpec) Specification of the desired behavior of a cron job, including the schedule. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status -- **status** (}}">CronJobStatus) +- **status** (}}">CronJobStatus) Current status of a cron job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status @@ -59,7 +59,7 @@ CronJobSpec describes how the job execution will look like and when it will actu Standard object's metadata of the jobs created from this template. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - - **jobTemplate.spec** (}}">JobSpec) + - **jobTemplate.spec** (}}">JobSpec) Specification of the desired behavior of the job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status @@ -128,7 +128,7 @@ CronJobList is a collection of cron jobs. Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata -- **items** ([]}}">CronJob), required +- **items** ([]}}">CronJob), required items is the list of CronJobs. @@ -175,7 +175,7 @@ GET /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name} #### Response -200 (}}">CronJob): OK +200 (}}">CronJob): OK 401: Unauthorized @@ -208,7 +208,7 @@ GET /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}/status #### Response -200 (}}">CronJob): OK +200 (}}">CronJob): OK 401: Unauthorized @@ -281,7 +281,7 @@ GET /apis/batch/v1beta1/namespaces/{namespace}/cronjobs #### Response -200 (}}">CronJobList): OK +200 (}}">CronJobList): OK 401: Unauthorized @@ -349,7 +349,7 @@ GET /apis/batch/v1beta1/cronjobs #### Response -200 (}}">CronJobList): OK +200 (}}">CronJobList): OK 401: Unauthorized @@ -368,7 +368,7 @@ POST /apis/batch/v1beta1/namespaces/{namespace}/cronjobs }}">namespace -- **body**: }}">CronJob, required +- **body**: }}">CronJob, required @@ -392,11 +392,11 @@ POST /apis/batch/v1beta1/namespaces/{namespace}/cronjobs #### Response -200 (}}">CronJob): OK +200 (}}">CronJob): OK -201 (}}">CronJob): Created +201 (}}">CronJob): Created -202 (}}">CronJob): Accepted +202 (}}">CronJob): Accepted 401: Unauthorized @@ -420,7 +420,7 @@ PUT /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name} }}">namespace -- **body**: }}">CronJob, required +- **body**: }}">CronJob, required @@ -444,9 +444,9 @@ PUT /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name} #### Response -200 (}}">CronJob): OK +200 (}}">CronJob): OK -201 (}}">CronJob): Created +201 (}}">CronJob): Created 401: Unauthorized @@ -470,7 +470,7 @@ PUT /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}/status }}">namespace -- **body**: }}">CronJob, required +- **body**: }}">CronJob, required @@ -494,9 +494,9 @@ PUT /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}/status #### Response -200 (}}">CronJob): OK +200 (}}">CronJob): OK -201 (}}">CronJob): Created +201 (}}">CronJob): Created 401: Unauthorized @@ -549,7 +549,7 @@ PATCH /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name} #### Response -200 (}}">CronJob): OK +200 (}}">CronJob): OK 401: Unauthorized @@ -602,7 +602,7 @@ PATCH /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}/status #### Response -200 (}}">CronJob): OK +200 (}}">CronJob): OK 401: Unauthorized diff --git a/content/en/docs/reference/kubernetes-api/workloads-resources/cron-job-v2alpha1.md b/content/en/docs/reference/kubernetes-api/workload-resources/cron-job-v2alpha1.md similarity index 88% rename from content/en/docs/reference/kubernetes-api/workloads-resources/cron-job-v2alpha1.md rename to content/en/docs/reference/kubernetes-api/workload-resources/cron-job-v2alpha1.md index c7c2ba7a81..fc6a933131 100644 --- a/content/en/docs/reference/kubernetes-api/workloads-resources/cron-job-v2alpha1.md +++ b/content/en/docs/reference/kubernetes-api/workload-resources/cron-job-v2alpha1.md @@ -30,11 +30,11 @@ CronJob represents the configuration of a single cron job. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata -- **spec** (}}">CronJobSpec) +- **spec** (}}">CronJobSpec) Specification of the desired behavior of a cron job, including the schedule. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status -- **status** (}}">CronJobStatus) +- **status** (}}">CronJobStatus) Current status of a cron job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status @@ -59,7 +59,7 @@ CronJobSpec describes how the job execution will look like and when it will actu Standard object's metadata of the jobs created from this template. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - - **jobTemplate.spec** (}}">JobSpec) + - **jobTemplate.spec** (}}">JobSpec) Specification of the desired behavior of the job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status @@ -128,7 +128,7 @@ CronJobList is a collection of cron jobs. Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata -- **items** ([]}}">CronJob), required +- **items** ([]}}">CronJob), required items is the list of CronJobs. @@ -175,7 +175,7 @@ GET /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name} #### Response -200 (}}">CronJob): OK +200 (}}">CronJob): OK 401: Unauthorized @@ -208,7 +208,7 @@ GET /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}/status #### Response -200 (}}">CronJob): OK +200 (}}">CronJob): OK 401: Unauthorized @@ -281,7 +281,7 @@ GET /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs #### Response -200 (}}">CronJobList): OK +200 (}}">CronJobList): OK 401: Unauthorized @@ -349,7 +349,7 @@ GET /apis/batch/v2alpha1/cronjobs #### Response -200 (}}">CronJobList): OK +200 (}}">CronJobList): OK 401: Unauthorized @@ -368,7 +368,7 @@ POST /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs }}">namespace -- **body**: }}">CronJob, required +- **body**: }}">CronJob, required @@ -392,11 +392,11 @@ POST /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs #### Response -200 (}}">CronJob): OK +200 (}}">CronJob): OK -201 (}}">CronJob): Created +201 (}}">CronJob): Created -202 (}}">CronJob): Accepted +202 (}}">CronJob): Accepted 401: Unauthorized @@ -420,7 +420,7 @@ PUT /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name} }}">namespace -- **body**: }}">CronJob, required +- **body**: }}">CronJob, required @@ -444,9 +444,9 @@ PUT /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name} #### Response -200 (}}">CronJob): OK +200 (}}">CronJob): OK -201 (}}">CronJob): Created +201 (}}">CronJob): Created 401: Unauthorized @@ -470,7 +470,7 @@ PUT /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}/status }}">namespace -- **body**: }}">CronJob, required +- **body**: }}">CronJob, required @@ -494,9 +494,9 @@ PUT /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}/status #### Response -200 (}}">CronJob): OK +200 (}}">CronJob): OK -201 (}}">CronJob): Created +201 (}}">CronJob): Created 401: Unauthorized @@ -549,7 +549,7 @@ PATCH /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name} #### Response -200 (}}">CronJob): OK +200 (}}">CronJob): OK 401: Unauthorized @@ -602,7 +602,7 @@ PATCH /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}/status #### Response -200 (}}">CronJob): OK +200 (}}">CronJob): OK 401: Unauthorized diff --git a/content/en/docs/reference/kubernetes-api/workloads-resources/daemon-set-v1.md b/content/en/docs/reference/kubernetes-api/workload-resources/daemon-set-v1.md similarity index 90% rename from content/en/docs/reference/kubernetes-api/workloads-resources/daemon-set-v1.md rename to content/en/docs/reference/kubernetes-api/workload-resources/daemon-set-v1.md index 95ae869be1..169d361c2a 100644 --- a/content/en/docs/reference/kubernetes-api/workloads-resources/daemon-set-v1.md +++ b/content/en/docs/reference/kubernetes-api/workload-resources/daemon-set-v1.md @@ -30,11 +30,11 @@ DaemonSet represents the configuration of a daemon set. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata -- **spec** (}}">DaemonSetSpec) +- **spec** (}}">DaemonSetSpec) The desired behavior of this daemon set. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status -- **status** (}}">DaemonSetStatus) +- **status** (}}">DaemonSetStatus) The current status of this daemon set. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status @@ -52,7 +52,7 @@ DaemonSetSpec is the specification of a daemon set. A label query over pods that are managed by the daemon set. Must match in order to be controlled. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors -- **template** (}}">PodTemplateSpec), required +- **template** (}}">PodTemplateSpec), 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 @@ -187,7 +187,7 @@ DaemonSetList is a collection of daemon sets. Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata -- **items** ([]}}">DaemonSet), required +- **items** ([]}}">DaemonSet), required A list of daemon sets. @@ -234,7 +234,7 @@ GET /apis/apps/v1/namespaces/{namespace}/daemonsets/{name} #### Response -200 (}}">DaemonSet): OK +200 (}}">DaemonSet): OK 401: Unauthorized @@ -267,7 +267,7 @@ GET /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status #### Response -200 (}}">DaemonSet): OK +200 (}}">DaemonSet): OK 401: Unauthorized @@ -340,7 +340,7 @@ GET /apis/apps/v1/namespaces/{namespace}/daemonsets #### Response -200 (}}">DaemonSetList): OK +200 (}}">DaemonSetList): OK 401: Unauthorized @@ -408,7 +408,7 @@ GET /apis/apps/v1/daemonsets #### Response -200 (}}">DaemonSetList): OK +200 (}}">DaemonSetList): OK 401: Unauthorized @@ -427,7 +427,7 @@ POST /apis/apps/v1/namespaces/{namespace}/daemonsets }}">namespace -- **body**: }}">DaemonSet, required +- **body**: }}">DaemonSet, required @@ -451,11 +451,11 @@ POST /apis/apps/v1/namespaces/{namespace}/daemonsets #### Response -200 (}}">DaemonSet): OK +200 (}}">DaemonSet): OK -201 (}}">DaemonSet): Created +201 (}}">DaemonSet): Created -202 (}}">DaemonSet): Accepted +202 (}}">DaemonSet): Accepted 401: Unauthorized @@ -479,7 +479,7 @@ PUT /apis/apps/v1/namespaces/{namespace}/daemonsets/{name} }}">namespace -- **body**: }}">DaemonSet, required +- **body**: }}">DaemonSet, required @@ -503,9 +503,9 @@ PUT /apis/apps/v1/namespaces/{namespace}/daemonsets/{name} #### Response -200 (}}">DaemonSet): OK +200 (}}">DaemonSet): OK -201 (}}">DaemonSet): Created +201 (}}">DaemonSet): Created 401: Unauthorized @@ -529,7 +529,7 @@ PUT /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status }}">namespace -- **body**: }}">DaemonSet, required +- **body**: }}">DaemonSet, required @@ -553,9 +553,9 @@ PUT /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status #### Response -200 (}}">DaemonSet): OK +200 (}}">DaemonSet): OK -201 (}}">DaemonSet): Created +201 (}}">DaemonSet): Created 401: Unauthorized @@ -608,7 +608,7 @@ PATCH /apis/apps/v1/namespaces/{namespace}/daemonsets/{name} #### Response -200 (}}">DaemonSet): OK +200 (}}">DaemonSet): OK 401: Unauthorized @@ -661,7 +661,7 @@ PATCH /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status #### Response -200 (}}">DaemonSet): OK +200 (}}">DaemonSet): OK 401: Unauthorized diff --git a/content/en/docs/reference/kubernetes-api/workloads-resources/deployment-v1.md b/content/en/docs/reference/kubernetes-api/workload-resources/deployment-v1.md similarity index 90% rename from content/en/docs/reference/kubernetes-api/workloads-resources/deployment-v1.md rename to content/en/docs/reference/kubernetes-api/workload-resources/deployment-v1.md index 7e5b39c929..052a54bcc8 100644 --- a/content/en/docs/reference/kubernetes-api/workloads-resources/deployment-v1.md +++ b/content/en/docs/reference/kubernetes-api/workload-resources/deployment-v1.md @@ -30,11 +30,11 @@ Deployment enables declarative updates for Pods and ReplicaSets. Standard object metadata. -- **spec** (}}">DeploymentSpec) +- **spec** (}}">DeploymentSpec) Specification of the desired behavior of the Deployment. -- **status** (}}">DeploymentStatus) +- **status** (}}">DeploymentStatus) Most recently observed status of the Deployment. @@ -52,7 +52,7 @@ DeploymentSpec is the specification of the desired behavior of the Deployment. Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. It must match the pod template's labels. -- **template** (}}">PodTemplateSpec), required +- **template** (}}">PodTemplateSpec), required Template describes the pods that will be created. @@ -207,7 +207,7 @@ DeploymentList is a list of Deployments. Standard list metadata. -- **items** ([]}}">Deployment), required +- **items** ([]}}">Deployment), required Items is the list of Deployments. @@ -254,7 +254,7 @@ GET /apis/apps/v1/namespaces/{namespace}/deployments/{name} #### Response -200 (}}">Deployment): OK +200 (}}">Deployment): OK 401: Unauthorized @@ -287,7 +287,7 @@ GET /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status #### Response -200 (}}">Deployment): OK +200 (}}">Deployment): OK 401: Unauthorized @@ -360,7 +360,7 @@ GET /apis/apps/v1/namespaces/{namespace}/deployments #### Response -200 (}}">DeploymentList): OK +200 (}}">DeploymentList): OK 401: Unauthorized @@ -428,7 +428,7 @@ GET /apis/apps/v1/deployments #### Response -200 (}}">DeploymentList): OK +200 (}}">DeploymentList): OK 401: Unauthorized @@ -447,7 +447,7 @@ POST /apis/apps/v1/namespaces/{namespace}/deployments }}">namespace -- **body**: }}">Deployment, required +- **body**: }}">Deployment, required @@ -471,11 +471,11 @@ POST /apis/apps/v1/namespaces/{namespace}/deployments #### Response -200 (}}">Deployment): OK +200 (}}">Deployment): OK -201 (}}">Deployment): Created +201 (}}">Deployment): Created -202 (}}">Deployment): Accepted +202 (}}">Deployment): Accepted 401: Unauthorized @@ -499,7 +499,7 @@ PUT /apis/apps/v1/namespaces/{namespace}/deployments/{name} }}">namespace -- **body**: }}">Deployment, required +- **body**: }}">Deployment, required @@ -523,9 +523,9 @@ PUT /apis/apps/v1/namespaces/{namespace}/deployments/{name} #### Response -200 (}}">Deployment): OK +200 (}}">Deployment): OK -201 (}}">Deployment): Created +201 (}}">Deployment): Created 401: Unauthorized @@ -549,7 +549,7 @@ PUT /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status }}">namespace -- **body**: }}">Deployment, required +- **body**: }}">Deployment, required @@ -573,9 +573,9 @@ PUT /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status #### Response -200 (}}">Deployment): OK +200 (}}">Deployment): OK -201 (}}">Deployment): Created +201 (}}">Deployment): Created 401: Unauthorized @@ -628,7 +628,7 @@ PATCH /apis/apps/v1/namespaces/{namespace}/deployments/{name} #### Response -200 (}}">Deployment): OK +200 (}}">Deployment): OK 401: Unauthorized @@ -681,7 +681,7 @@ PATCH /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status #### Response -200 (}}">Deployment): OK +200 (}}">Deployment): OK 401: Unauthorized diff --git a/content/en/docs/reference/kubernetes-api/workloads-resources/ephemeral-container.md b/content/en/docs/reference/kubernetes-api/workload-resources/ephemeral-container.md similarity index 100% rename from content/en/docs/reference/kubernetes-api/workloads-resources/ephemeral-container.md rename to content/en/docs/reference/kubernetes-api/workload-resources/ephemeral-container.md diff --git a/content/en/docs/reference/kubernetes-api/workloads-resources/horizontal-pod-autoscaler-v1.md b/content/en/docs/reference/kubernetes-api/workload-resources/horizontal-pod-autoscaler-v1.md similarity index 85% rename from content/en/docs/reference/kubernetes-api/workloads-resources/horizontal-pod-autoscaler-v1.md rename to content/en/docs/reference/kubernetes-api/workload-resources/horizontal-pod-autoscaler-v1.md index 5bb2f6e175..8ed1581cbe 100644 --- a/content/en/docs/reference/kubernetes-api/workloads-resources/horizontal-pod-autoscaler-v1.md +++ b/content/en/docs/reference/kubernetes-api/workload-resources/horizontal-pod-autoscaler-v1.md @@ -30,11 +30,11 @@ configuration of a horizontal pod autoscaler. Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata -- **spec** (}}">HorizontalPodAutoscalerSpec) +- **spec** (}}">HorizontalPodAutoscalerSpec) behaviour of autoscaler. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. -- **status** (}}">HorizontalPodAutoscalerStatus) +- **status** (}}">HorizontalPodAutoscalerStatus) current information about the autoscaler. @@ -132,7 +132,7 @@ list of horizontal pod autoscaler objects. Standard list metadata. -- **items** ([]}}">HorizontalPodAutoscaler), required +- **items** ([]}}">HorizontalPodAutoscaler), required list of horizontal pod autoscaler objects. @@ -179,7 +179,7 @@ GET /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name} #### Response -200 (}}">HorizontalPodAutoscaler): OK +200 (}}">HorizontalPodAutoscaler): OK 401: Unauthorized @@ -212,7 +212,7 @@ GET /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/ #### Response -200 (}}">HorizontalPodAutoscaler): OK +200 (}}">HorizontalPodAutoscaler): OK 401: Unauthorized @@ -285,7 +285,7 @@ GET /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers #### Response -200 (}}">HorizontalPodAutoscalerList): OK +200 (}}">HorizontalPodAutoscalerList): OK 401: Unauthorized @@ -353,7 +353,7 @@ GET /apis/autoscaling/v1/horizontalpodautoscalers #### Response -200 (}}">HorizontalPodAutoscalerList): OK +200 (}}">HorizontalPodAutoscalerList): OK 401: Unauthorized @@ -372,7 +372,7 @@ POST /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers }}">namespace -- **body**: }}">HorizontalPodAutoscaler, required +- **body**: }}">HorizontalPodAutoscaler, required @@ -396,11 +396,11 @@ POST /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers #### Response -200 (}}">HorizontalPodAutoscaler): OK +200 (}}">HorizontalPodAutoscaler): OK -201 (}}">HorizontalPodAutoscaler): Created +201 (}}">HorizontalPodAutoscaler): Created -202 (}}">HorizontalPodAutoscaler): Accepted +202 (}}">HorizontalPodAutoscaler): Accepted 401: Unauthorized @@ -424,7 +424,7 @@ PUT /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name} }}">namespace -- **body**: }}">HorizontalPodAutoscaler, required +- **body**: }}">HorizontalPodAutoscaler, required @@ -448,9 +448,9 @@ PUT /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name} #### Response -200 (}}">HorizontalPodAutoscaler): OK +200 (}}">HorizontalPodAutoscaler): OK -201 (}}">HorizontalPodAutoscaler): Created +201 (}}">HorizontalPodAutoscaler): Created 401: Unauthorized @@ -474,7 +474,7 @@ PUT /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/ }}">namespace -- **body**: }}">HorizontalPodAutoscaler, required +- **body**: }}">HorizontalPodAutoscaler, required @@ -498,9 +498,9 @@ PUT /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/ #### Response -200 (}}">HorizontalPodAutoscaler): OK +200 (}}">HorizontalPodAutoscaler): OK -201 (}}">HorizontalPodAutoscaler): Created +201 (}}">HorizontalPodAutoscaler): Created 401: Unauthorized @@ -553,7 +553,7 @@ PATCH /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name #### Response -200 (}}">HorizontalPodAutoscaler): OK +200 (}}">HorizontalPodAutoscaler): OK 401: Unauthorized @@ -606,7 +606,7 @@ PATCH /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name #### Response -200 (}}">HorizontalPodAutoscaler): OK +200 (}}">HorizontalPodAutoscaler): OK 401: Unauthorized diff --git a/content/en/docs/reference/kubernetes-api/workloads-resources/horizontal-pod-autoscaler-v2beta2.md b/content/en/docs/reference/kubernetes-api/workload-resources/horizontal-pod-autoscaler-v2beta2.md similarity index 94% rename from content/en/docs/reference/kubernetes-api/workloads-resources/horizontal-pod-autoscaler-v2beta2.md rename to content/en/docs/reference/kubernetes-api/workload-resources/horizontal-pod-autoscaler-v2beta2.md index 56fd55d24b..2f8f15d505 100644 --- a/content/en/docs/reference/kubernetes-api/workloads-resources/horizontal-pod-autoscaler-v2beta2.md +++ b/content/en/docs/reference/kubernetes-api/workload-resources/horizontal-pod-autoscaler-v2beta2.md @@ -30,11 +30,11 @@ HorizontalPodAutoscaler is the configuration for a horizontal pod autoscaler, wh metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata -- **spec** (}}">HorizontalPodAutoscalerSpec) +- **spec** (}}">HorizontalPodAutoscalerSpec) spec is the specification for the behaviour of the autoscaler. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. -- **status** (}}">HorizontalPodAutoscalerStatus) +- **status** (}}">HorizontalPodAutoscalerStatus) status is the current information about the autoscaler. @@ -684,7 +684,7 @@ HorizontalPodAutoscalerList is a list of horizontal pod autoscaler objects. metadata is the standard list metadata. -- **items** ([]}}">HorizontalPodAutoscaler), required +- **items** ([]}}">HorizontalPodAutoscaler), required items is the list of horizontal pod autoscaler objects. @@ -731,7 +731,7 @@ GET /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{n #### Response -200 (}}">HorizontalPodAutoscaler): OK +200 (}}">HorizontalPodAutoscaler): OK 401: Unauthorized @@ -764,7 +764,7 @@ GET /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{n #### Response -200 (}}">HorizontalPodAutoscaler): OK +200 (}}">HorizontalPodAutoscaler): OK 401: Unauthorized @@ -837,7 +837,7 @@ GET /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers #### Response -200 (}}">HorizontalPodAutoscalerList): OK +200 (}}">HorizontalPodAutoscalerList): OK 401: Unauthorized @@ -905,7 +905,7 @@ GET /apis/autoscaling/v2beta2/horizontalpodautoscalers #### Response -200 (}}">HorizontalPodAutoscalerList): OK +200 (}}">HorizontalPodAutoscalerList): OK 401: Unauthorized @@ -924,7 +924,7 @@ POST /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers }}">namespace -- **body**: }}">HorizontalPodAutoscaler, required +- **body**: }}">HorizontalPodAutoscaler, required @@ -948,11 +948,11 @@ POST /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers #### Response -200 (}}">HorizontalPodAutoscaler): OK +200 (}}">HorizontalPodAutoscaler): OK -201 (}}">HorizontalPodAutoscaler): Created +201 (}}">HorizontalPodAutoscaler): Created -202 (}}">HorizontalPodAutoscaler): Accepted +202 (}}">HorizontalPodAutoscaler): Accepted 401: Unauthorized @@ -976,7 +976,7 @@ PUT /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{n }}">namespace -- **body**: }}">HorizontalPodAutoscaler, required +- **body**: }}">HorizontalPodAutoscaler, required @@ -1000,9 +1000,9 @@ PUT /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{n #### Response -200 (}}">HorizontalPodAutoscaler): OK +200 (}}">HorizontalPodAutoscaler): OK -201 (}}">HorizontalPodAutoscaler): Created +201 (}}">HorizontalPodAutoscaler): Created 401: Unauthorized @@ -1026,7 +1026,7 @@ PUT /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{n }}">namespace -- **body**: }}">HorizontalPodAutoscaler, required +- **body**: }}">HorizontalPodAutoscaler, required @@ -1050,9 +1050,9 @@ PUT /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{n #### Response -200 (}}">HorizontalPodAutoscaler): OK +200 (}}">HorizontalPodAutoscaler): OK -201 (}}">HorizontalPodAutoscaler): Created +201 (}}">HorizontalPodAutoscaler): Created 401: Unauthorized @@ -1105,7 +1105,7 @@ PATCH /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/ #### Response -200 (}}">HorizontalPodAutoscaler): OK +200 (}}">HorizontalPodAutoscaler): OK 401: Unauthorized @@ -1158,7 +1158,7 @@ PATCH /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/ #### Response -200 (}}">HorizontalPodAutoscaler): OK +200 (}}">HorizontalPodAutoscaler): OK 401: Unauthorized diff --git a/content/en/docs/reference/kubernetes-api/workloads-resources/job-v1.md b/content/en/docs/reference/kubernetes-api/workload-resources/job-v1.md similarity index 91% rename from content/en/docs/reference/kubernetes-api/workloads-resources/job-v1.md rename to content/en/docs/reference/kubernetes-api/workload-resources/job-v1.md index 3deab1c4be..f01c257e45 100644 --- a/content/en/docs/reference/kubernetes-api/workloads-resources/job-v1.md +++ b/content/en/docs/reference/kubernetes-api/workload-resources/job-v1.md @@ -30,11 +30,11 @@ Job represents the configuration of a single job. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata -- **spec** (}}">JobSpec) +- **spec** (}}">JobSpec) Specification of the desired behavior of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status -- **status** (}}">JobStatus) +- **status** (}}">JobStatus) Current status of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status @@ -53,7 +53,7 @@ JobSpec describes how the job execution will look like. ### Replicas -- **template** (}}">PodTemplateSpec), required +- **template** (}}">PodTemplateSpec), 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/ @@ -184,7 +184,7 @@ JobList is a collection of jobs. Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata -- **items** ([]}}">Job), required +- **items** ([]}}">Job), required items is the list of Jobs. @@ -231,7 +231,7 @@ GET /apis/batch/v1/namespaces/{namespace}/jobs/{name} #### Response -200 (}}">Job): OK +200 (}}">Job): OK 401: Unauthorized @@ -264,7 +264,7 @@ GET /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status #### Response -200 (}}">Job): OK +200 (}}">Job): OK 401: Unauthorized @@ -337,7 +337,7 @@ GET /apis/batch/v1/namespaces/{namespace}/jobs #### Response -200 (}}">JobList): OK +200 (}}">JobList): OK 401: Unauthorized @@ -405,7 +405,7 @@ GET /apis/batch/v1/jobs #### Response -200 (}}">JobList): OK +200 (}}">JobList): OK 401: Unauthorized @@ -424,7 +424,7 @@ POST /apis/batch/v1/namespaces/{namespace}/jobs }}">namespace -- **body**: }}">Job, required +- **body**: }}">Job, required @@ -448,11 +448,11 @@ POST /apis/batch/v1/namespaces/{namespace}/jobs #### Response -200 (}}">Job): OK +200 (}}">Job): OK -201 (}}">Job): Created +201 (}}">Job): Created -202 (}}">Job): Accepted +202 (}}">Job): Accepted 401: Unauthorized @@ -476,7 +476,7 @@ PUT /apis/batch/v1/namespaces/{namespace}/jobs/{name} }}">namespace -- **body**: }}">Job, required +- **body**: }}">Job, required @@ -500,9 +500,9 @@ PUT /apis/batch/v1/namespaces/{namespace}/jobs/{name} #### Response -200 (}}">Job): OK +200 (}}">Job): OK -201 (}}">Job): Created +201 (}}">Job): Created 401: Unauthorized @@ -526,7 +526,7 @@ PUT /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status }}">namespace -- **body**: }}">Job, required +- **body**: }}">Job, required @@ -550,9 +550,9 @@ PUT /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status #### Response -200 (}}">Job): OK +200 (}}">Job): OK -201 (}}">Job): Created +201 (}}">Job): Created 401: Unauthorized @@ -605,7 +605,7 @@ PATCH /apis/batch/v1/namespaces/{namespace}/jobs/{name} #### Response -200 (}}">Job): OK +200 (}}">Job): OK 401: Unauthorized @@ -658,7 +658,7 @@ PATCH /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status #### Response -200 (}}">Job): OK +200 (}}">Job): OK 401: Unauthorized diff --git a/content/en/docs/reference/kubernetes-api/workloads-resources/pod-template-v1.md b/content/en/docs/reference/kubernetes-api/workload-resources/pod-template-v1.md similarity index 86% rename from content/en/docs/reference/kubernetes-api/workloads-resources/pod-template-v1.md rename to content/en/docs/reference/kubernetes-api/workload-resources/pod-template-v1.md index fec34df19f..663ab6bea4 100644 --- a/content/en/docs/reference/kubernetes-api/workloads-resources/pod-template-v1.md +++ b/content/en/docs/reference/kubernetes-api/workload-resources/pod-template-v1.md @@ -30,7 +30,7 @@ PodTemplate describes a template for creating copies of a predefined pod. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata -- **template** (}}">PodTemplateSpec) +- **template** (}}">PodTemplateSpec) Template defines the pods that will be created from this pod template. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status @@ -48,7 +48,7 @@ PodTemplateSpec describes the data a pod should have when created from a templat Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata -- **spec** (}}">PodSpec) +- **spec** (}}">PodSpec) Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status @@ -72,7 +72,7 @@ PodTemplateList is a list of PodTemplates. Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -- **items** ([]}}">PodTemplate), required +- **items** ([]}}">PodTemplate), required List of pod templates @@ -119,7 +119,7 @@ GET /api/v1/namespaces/{namespace}/podtemplates/{name} #### Response -200 (}}">PodTemplate): OK +200 (}}">PodTemplate): OK 401: Unauthorized @@ -192,7 +192,7 @@ GET /api/v1/namespaces/{namespace}/podtemplates #### Response -200 (}}">PodTemplateList): OK +200 (}}">PodTemplateList): OK 401: Unauthorized @@ -260,7 +260,7 @@ GET /api/v1/podtemplates #### Response -200 (}}">PodTemplateList): OK +200 (}}">PodTemplateList): OK 401: Unauthorized @@ -279,7 +279,7 @@ POST /api/v1/namespaces/{namespace}/podtemplates }}">namespace -- **body**: }}">PodTemplate, required +- **body**: }}">PodTemplate, required @@ -303,11 +303,11 @@ POST /api/v1/namespaces/{namespace}/podtemplates #### Response -200 (}}">PodTemplate): OK +200 (}}">PodTemplate): OK -201 (}}">PodTemplate): Created +201 (}}">PodTemplate): Created -202 (}}">PodTemplate): Accepted +202 (}}">PodTemplate): Accepted 401: Unauthorized @@ -331,7 +331,7 @@ PUT /api/v1/namespaces/{namespace}/podtemplates/{name} }}">namespace -- **body**: }}">PodTemplate, required +- **body**: }}">PodTemplate, required @@ -355,9 +355,9 @@ PUT /api/v1/namespaces/{namespace}/podtemplates/{name} #### Response -200 (}}">PodTemplate): OK +200 (}}">PodTemplate): OK -201 (}}">PodTemplate): Created +201 (}}">PodTemplate): Created 401: Unauthorized @@ -410,7 +410,7 @@ PATCH /api/v1/namespaces/{namespace}/podtemplates/{name} #### Response -200 (}}">PodTemplate): OK +200 (}}">PodTemplate): OK 401: Unauthorized @@ -463,9 +463,9 @@ DELETE /api/v1/namespaces/{namespace}/podtemplates/{name} #### Response -200 (}}">PodTemplate): OK +200 (}}">PodTemplate): OK -202 (}}">PodTemplate): Accepted +202 (}}">PodTemplate): Accepted 401: Unauthorized diff --git a/content/en/docs/reference/kubernetes-api/workloads-resources/pod-v1.md b/content/en/docs/reference/kubernetes-api/workload-resources/pod-v1.md similarity index 94% rename from content/en/docs/reference/kubernetes-api/workloads-resources/pod-v1.md rename to content/en/docs/reference/kubernetes-api/workload-resources/pod-v1.md index 584c338172..4be3289e9f 100644 --- a/content/en/docs/reference/kubernetes-api/workloads-resources/pod-v1.md +++ b/content/en/docs/reference/kubernetes-api/workload-resources/pod-v1.md @@ -30,11 +30,11 @@ Pod is a collection of containers that can run on a host. This resource is creat Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata -- **spec** (}}">PodSpec) +- **spec** (}}">PodSpec) Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status -- **status** (}}">PodStatus) +- **status** (}}">PodStatus) Most recently observed status of the pod. This data may not be up to date. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status @@ -53,13 +53,13 @@ PodSpec is a description of a pod. ### Containers -- **containers** ([]}}">Container), required +- **containers** ([]}}">Container), required *Patch strategy: merge on key `name`* List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. -- **initContainers** ([]}}">Container) +- **initContainers** ([]}}">Container) *Patch strategy: merge on key `name`* @@ -430,7 +430,7 @@ PodSpec is a description of a pod. ### Alpha level -- **ephemeralContainers** ([]}}">EphemeralContainer) +- **ephemeralContainers** ([]}}">EphemeralContainer) *Patch strategy: merge on key `name`* @@ -547,15 +547,15 @@ PodStatus represents information about the status of a pod. Status may trail the 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 -- **initContainerStatuses** ([]}}">ContainerStatus) +- **initContainerStatuses** ([]}}">ContainerStatus) The list has one entry per init container in the manifest. The most recent successful init container will have ready = true, the most recently started container will have startTime set. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status -- **containerStatuses** ([]}}">ContainerStatus) +- **containerStatuses** ([]}}">ContainerStatus) The list has one entry per container in the manifest. Each entry is currently the output of `docker inspect`. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status -- **ephemeralContainerStatuses** ([]}}">ContainerStatus) +- **ephemeralContainerStatuses** ([]}}">ContainerStatus) Status for any ephemeral containers that have run in this pod. This field is alpha-level and is only populated by servers that enable the EphemeralContainers feature. @@ -579,7 +579,7 @@ PodList is a list of Pods. Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -- **items** ([]}}">Pod), required +- **items** ([]}}">Pod), required List of pods. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md @@ -626,7 +626,7 @@ GET /api/v1/namespaces/{namespace}/pods/{name} #### Response -200 (}}">Pod): OK +200 (}}">Pod): OK 401: Unauthorized @@ -732,7 +732,7 @@ GET /api/v1/namespaces/{namespace}/pods/{name}/status #### Response -200 (}}">Pod): OK +200 (}}">Pod): OK 401: Unauthorized @@ -805,7 +805,7 @@ GET /api/v1/namespaces/{namespace}/pods #### Response -200 (}}">PodList): OK +200 (}}">PodList): OK 401: Unauthorized @@ -873,7 +873,7 @@ GET /api/v1/pods #### Response -200 (}}">PodList): OK +200 (}}">PodList): OK 401: Unauthorized @@ -892,7 +892,7 @@ POST /api/v1/namespaces/{namespace}/pods }}">namespace -- **body**: }}">Pod, required +- **body**: }}">Pod, required @@ -916,11 +916,11 @@ POST /api/v1/namespaces/{namespace}/pods #### Response -200 (}}">Pod): OK +200 (}}">Pod): OK -201 (}}">Pod): Created +201 (}}">Pod): Created -202 (}}">Pod): Accepted +202 (}}">Pod): Accepted 401: Unauthorized @@ -944,7 +944,7 @@ PUT /api/v1/namespaces/{namespace}/pods/{name} }}">namespace -- **body**: }}">Pod, required +- **body**: }}">Pod, required @@ -968,9 +968,9 @@ PUT /api/v1/namespaces/{namespace}/pods/{name} #### Response -200 (}}">Pod): OK +200 (}}">Pod): OK -201 (}}">Pod): Created +201 (}}">Pod): Created 401: Unauthorized @@ -994,7 +994,7 @@ PUT /api/v1/namespaces/{namespace}/pods/{name}/status }}">namespace -- **body**: }}">Pod, required +- **body**: }}">Pod, required @@ -1018,9 +1018,9 @@ PUT /api/v1/namespaces/{namespace}/pods/{name}/status #### Response -200 (}}">Pod): OK +200 (}}">Pod): OK -201 (}}">Pod): Created +201 (}}">Pod): Created 401: Unauthorized @@ -1073,7 +1073,7 @@ PATCH /api/v1/namespaces/{namespace}/pods/{name} #### Response -200 (}}">Pod): OK +200 (}}">Pod): OK 401: Unauthorized @@ -1126,7 +1126,7 @@ PATCH /api/v1/namespaces/{namespace}/pods/{name}/status #### Response -200 (}}">Pod): OK +200 (}}">Pod): OK 401: Unauthorized @@ -1179,9 +1179,9 @@ DELETE /api/v1/namespaces/{namespace}/pods/{name} #### Response -200 (}}">Pod): OK +200 (}}">Pod): OK -202 (}}">Pod): Accepted +202 (}}">Pod): Accepted 401: Unauthorized diff --git a/content/en/docs/reference/kubernetes-api/workloads-resources/priority-class-v1.md b/content/en/docs/reference/kubernetes-api/workload-resources/priority-class-v1.md similarity index 88% rename from content/en/docs/reference/kubernetes-api/workloads-resources/priority-class-v1.md rename to content/en/docs/reference/kubernetes-api/workload-resources/priority-class-v1.md index 30b40e6840..28087807c1 100644 --- a/content/en/docs/reference/kubernetes-api/workloads-resources/priority-class-v1.md +++ b/content/en/docs/reference/kubernetes-api/workload-resources/priority-class-v1.md @@ -66,7 +66,7 @@ PriorityClassList is a collection of priority classes. Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata -- **items** ([]}}">PriorityClass), required +- **items** ([]}}">PriorityClass), required items is the list of PriorityClasses @@ -108,7 +108,7 @@ GET /apis/scheduling.k8s.io/v1/priorityclasses/{name} #### Response -200 (}}">PriorityClass): OK +200 (}}">PriorityClass): OK 401: Unauthorized @@ -176,7 +176,7 @@ GET /apis/scheduling.k8s.io/v1/priorityclasses #### Response -200 (}}">PriorityClassList): OK +200 (}}">PriorityClassList): OK 401: Unauthorized @@ -190,7 +190,7 @@ POST /apis/scheduling.k8s.io/v1/priorityclasses #### Parameters -- **body**: }}">PriorityClass, required +- **body**: }}">PriorityClass, required @@ -214,11 +214,11 @@ POST /apis/scheduling.k8s.io/v1/priorityclasses #### Response -200 (}}">PriorityClass): OK +200 (}}">PriorityClass): OK -201 (}}">PriorityClass): Created +201 (}}">PriorityClass): Created -202 (}}">PriorityClass): Accepted +202 (}}">PriorityClass): Accepted 401: Unauthorized @@ -237,7 +237,7 @@ PUT /apis/scheduling.k8s.io/v1/priorityclasses/{name} name of the PriorityClass -- **body**: }}">PriorityClass, required +- **body**: }}">PriorityClass, required @@ -261,9 +261,9 @@ PUT /apis/scheduling.k8s.io/v1/priorityclasses/{name} #### Response -200 (}}">PriorityClass): OK +200 (}}">PriorityClass): OK -201 (}}">PriorityClass): Created +201 (}}">PriorityClass): Created 401: Unauthorized @@ -311,7 +311,7 @@ PATCH /apis/scheduling.k8s.io/v1/priorityclasses/{name} #### Response -200 (}}">PriorityClass): OK +200 (}}">PriorityClass): OK 401: Unauthorized diff --git a/content/en/docs/reference/kubernetes-api/workloads-resources/replica-set-v1.md b/content/en/docs/reference/kubernetes-api/workload-resources/replica-set-v1.md similarity index 88% rename from content/en/docs/reference/kubernetes-api/workloads-resources/replica-set-v1.md rename to content/en/docs/reference/kubernetes-api/workload-resources/replica-set-v1.md index 429a1bd5a2..708b0fd966 100644 --- a/content/en/docs/reference/kubernetes-api/workloads-resources/replica-set-v1.md +++ b/content/en/docs/reference/kubernetes-api/workload-resources/replica-set-v1.md @@ -30,11 +30,11 @@ ReplicaSet ensures that a specified number of pod replicas are running at any gi If the Labels of a ReplicaSet are empty, they are defaulted to be the same as the Pod(s) that the ReplicaSet manages. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata -- **spec** (}}">ReplicaSetSpec) +- **spec** (}}">ReplicaSetSpec) Spec defines the specification of the desired behavior of the ReplicaSet. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status -- **status** (}}">ReplicaSetStatus) +- **status** (}}">ReplicaSetStatus) Status is the most recently observed status of the ReplicaSet. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status @@ -52,7 +52,7 @@ ReplicaSetSpec is the specification of a ReplicaSet. Selector is a label query over pods that should match the replica count. Label keys and values that must match in order to be controlled by this replica set. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors -- **template** (}}">PodTemplateSpec) +- **template** (}}">PodTemplateSpec) Template is the object that describes the pod that will be created if insufficient replicas are detected. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template @@ -146,7 +146,7 @@ ReplicaSetList is a collection of ReplicaSets. Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -- **items** ([]}}">ReplicaSet), required +- **items** ([]}}">ReplicaSet), required List of ReplicaSets. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller @@ -193,7 +193,7 @@ GET /apis/apps/v1/namespaces/{namespace}/replicasets/{name} #### Response -200 (}}">ReplicaSet): OK +200 (}}">ReplicaSet): OK 401: Unauthorized @@ -226,7 +226,7 @@ GET /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status #### Response -200 (}}">ReplicaSet): OK +200 (}}">ReplicaSet): OK 401: Unauthorized @@ -299,7 +299,7 @@ GET /apis/apps/v1/namespaces/{namespace}/replicasets #### Response -200 (}}">ReplicaSetList): OK +200 (}}">ReplicaSetList): OK 401: Unauthorized @@ -367,7 +367,7 @@ GET /apis/apps/v1/replicasets #### Response -200 (}}">ReplicaSetList): OK +200 (}}">ReplicaSetList): OK 401: Unauthorized @@ -386,7 +386,7 @@ POST /apis/apps/v1/namespaces/{namespace}/replicasets }}">namespace -- **body**: }}">ReplicaSet, required +- **body**: }}">ReplicaSet, required @@ -410,11 +410,11 @@ POST /apis/apps/v1/namespaces/{namespace}/replicasets #### Response -200 (}}">ReplicaSet): OK +200 (}}">ReplicaSet): OK -201 (}}">ReplicaSet): Created +201 (}}">ReplicaSet): Created -202 (}}">ReplicaSet): Accepted +202 (}}">ReplicaSet): Accepted 401: Unauthorized @@ -438,7 +438,7 @@ PUT /apis/apps/v1/namespaces/{namespace}/replicasets/{name} }}">namespace -- **body**: }}">ReplicaSet, required +- **body**: }}">ReplicaSet, required @@ -462,9 +462,9 @@ PUT /apis/apps/v1/namespaces/{namespace}/replicasets/{name} #### Response -200 (}}">ReplicaSet): OK +200 (}}">ReplicaSet): OK -201 (}}">ReplicaSet): Created +201 (}}">ReplicaSet): Created 401: Unauthorized @@ -488,7 +488,7 @@ PUT /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status }}">namespace -- **body**: }}">ReplicaSet, required +- **body**: }}">ReplicaSet, required @@ -512,9 +512,9 @@ PUT /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status #### Response -200 (}}">ReplicaSet): OK +200 (}}">ReplicaSet): OK -201 (}}">ReplicaSet): Created +201 (}}">ReplicaSet): Created 401: Unauthorized @@ -567,7 +567,7 @@ PATCH /apis/apps/v1/namespaces/{namespace}/replicasets/{name} #### Response -200 (}}">ReplicaSet): OK +200 (}}">ReplicaSet): OK 401: Unauthorized @@ -620,7 +620,7 @@ PATCH /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status #### Response -200 (}}">ReplicaSet): OK +200 (}}">ReplicaSet): OK 401: Unauthorized diff --git a/content/en/docs/reference/kubernetes-api/workloads-resources/replication-controller-v1.md b/content/en/docs/reference/kubernetes-api/workload-resources/replication-controller-v1.md similarity index 86% rename from content/en/docs/reference/kubernetes-api/workloads-resources/replication-controller-v1.md rename to content/en/docs/reference/kubernetes-api/workload-resources/replication-controller-v1.md index 2970b6670c..1f7962ee96 100644 --- a/content/en/docs/reference/kubernetes-api/workloads-resources/replication-controller-v1.md +++ b/content/en/docs/reference/kubernetes-api/workload-resources/replication-controller-v1.md @@ -30,11 +30,11 @@ ReplicationController represents the configuration of a replication controller. If the Labels of a ReplicationController are empty, they are defaulted to be the same as the Pod(s) that the replication controller manages. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata -- **spec** (}}">ReplicationControllerSpec) +- **spec** (}}">ReplicationControllerSpec) Spec defines the specification of the desired behavior of the replication controller. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status -- **status** (}}">ReplicationControllerStatus) +- **status** (}}">ReplicationControllerStatus) Status is the most recently observed status of the replication controller. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status @@ -52,7 +52,7 @@ ReplicationControllerSpec is the specification of a replication controller. Selector is a label query over pods that should match the Replicas count. If Selector is empty, it is defaulted to the labels present on the Pod template. Label keys and values that must match in order to be controlled by this replication controller, if empty defaulted to labels on Pod template. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors -- **template** (}}">PodTemplateSpec) +- **template** (}}">PodTemplateSpec) Template is the object that describes the pod that will be created if insufficient replicas are detected. This takes precedence over a TemplateRef. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template @@ -146,7 +146,7 @@ ReplicationControllerList is a collection of replication controllers. Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -- **items** ([]}}">ReplicationController), required +- **items** ([]}}">ReplicationController), required List of replication controllers. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller @@ -193,7 +193,7 @@ GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name} #### Response -200 (}}">ReplicationController): OK +200 (}}">ReplicationController): OK 401: Unauthorized @@ -226,7 +226,7 @@ GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status #### Response -200 (}}">ReplicationController): OK +200 (}}">ReplicationController): OK 401: Unauthorized @@ -299,7 +299,7 @@ GET /api/v1/namespaces/{namespace}/replicationcontrollers #### Response -200 (}}">ReplicationControllerList): OK +200 (}}">ReplicationControllerList): OK 401: Unauthorized @@ -367,7 +367,7 @@ GET /api/v1/replicationcontrollers #### Response -200 (}}">ReplicationControllerList): OK +200 (}}">ReplicationControllerList): OK 401: Unauthorized @@ -386,7 +386,7 @@ POST /api/v1/namespaces/{namespace}/replicationcontrollers }}">namespace -- **body**: }}">ReplicationController, required +- **body**: }}">ReplicationController, required @@ -410,11 +410,11 @@ POST /api/v1/namespaces/{namespace}/replicationcontrollers #### Response -200 (}}">ReplicationController): OK +200 (}}">ReplicationController): OK -201 (}}">ReplicationController): Created +201 (}}">ReplicationController): Created -202 (}}">ReplicationController): Accepted +202 (}}">ReplicationController): Accepted 401: Unauthorized @@ -438,7 +438,7 @@ PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name} }}">namespace -- **body**: }}">ReplicationController, required +- **body**: }}">ReplicationController, required @@ -462,9 +462,9 @@ PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name} #### Response -200 (}}">ReplicationController): OK +200 (}}">ReplicationController): OK -201 (}}">ReplicationController): Created +201 (}}">ReplicationController): Created 401: Unauthorized @@ -488,7 +488,7 @@ PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status }}">namespace -- **body**: }}">ReplicationController, required +- **body**: }}">ReplicationController, required @@ -512,9 +512,9 @@ PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status #### Response -200 (}}">ReplicationController): OK +200 (}}">ReplicationController): OK -201 (}}">ReplicationController): Created +201 (}}">ReplicationController): Created 401: Unauthorized @@ -567,7 +567,7 @@ PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name} #### Response -200 (}}">ReplicationController): OK +200 (}}">ReplicationController): OK 401: Unauthorized @@ -620,7 +620,7 @@ PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status #### Response -200 (}}">ReplicationController): OK +200 (}}">ReplicationController): OK 401: Unauthorized diff --git a/content/en/docs/reference/kubernetes-api/workloads-resources/stateful-set-v1.md b/content/en/docs/reference/kubernetes-api/workload-resources/stateful-set-v1.md similarity index 89% rename from content/en/docs/reference/kubernetes-api/workloads-resources/stateful-set-v1.md rename to content/en/docs/reference/kubernetes-api/workload-resources/stateful-set-v1.md index 1a55fa4c1d..17ea7755f2 100644 --- a/content/en/docs/reference/kubernetes-api/workloads-resources/stateful-set-v1.md +++ b/content/en/docs/reference/kubernetes-api/workload-resources/stateful-set-v1.md @@ -32,11 +32,11 @@ The StatefulSet guarantees that a given network identity will always map to the - **metadata** (}}">ObjectMeta) -- **spec** (}}">StatefulSetSpec) +- **spec** (}}">StatefulSetSpec) Spec defines the desired identities of pods in this set. -- **status** (}}">StatefulSetStatus) +- **status** (}}">StatefulSetStatus) Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time. @@ -58,7 +58,7 @@ A StatefulSetSpec is the specification of a StatefulSet. selector is a label query over pods that should match the replica count. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors -- **template** (}}">PodTemplateSpec), required +- **template** (}}">PodTemplateSpec), 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. @@ -193,7 +193,7 @@ StatefulSetList is a collection of StatefulSets. - **metadata** (}}">ListMeta) -- **items** ([]}}">StatefulSet), required +- **items** ([]}}">StatefulSet), required @@ -239,7 +239,7 @@ GET /apis/apps/v1/namespaces/{namespace}/statefulsets/{name} #### Response -200 (}}">StatefulSet): OK +200 (}}">StatefulSet): OK 401: Unauthorized @@ -272,7 +272,7 @@ GET /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status #### Response -200 (}}">StatefulSet): OK +200 (}}">StatefulSet): OK 401: Unauthorized @@ -345,7 +345,7 @@ GET /apis/apps/v1/namespaces/{namespace}/statefulsets #### Response -200 (}}">StatefulSetList): OK +200 (}}">StatefulSetList): OK 401: Unauthorized @@ -413,7 +413,7 @@ GET /apis/apps/v1/statefulsets #### Response -200 (}}">StatefulSetList): OK +200 (}}">StatefulSetList): OK 401: Unauthorized @@ -432,7 +432,7 @@ POST /apis/apps/v1/namespaces/{namespace}/statefulsets }}">namespace -- **body**: }}">StatefulSet, required +- **body**: }}">StatefulSet, required @@ -456,11 +456,11 @@ POST /apis/apps/v1/namespaces/{namespace}/statefulsets #### Response -200 (}}">StatefulSet): OK +200 (}}">StatefulSet): OK -201 (}}">StatefulSet): Created +201 (}}">StatefulSet): Created -202 (}}">StatefulSet): Accepted +202 (}}">StatefulSet): Accepted 401: Unauthorized @@ -484,7 +484,7 @@ PUT /apis/apps/v1/namespaces/{namespace}/statefulsets/{name} }}">namespace -- **body**: }}">StatefulSet, required +- **body**: }}">StatefulSet, required @@ -508,9 +508,9 @@ PUT /apis/apps/v1/namespaces/{namespace}/statefulsets/{name} #### Response -200 (}}">StatefulSet): OK +200 (}}">StatefulSet): OK -201 (}}">StatefulSet): Created +201 (}}">StatefulSet): Created 401: Unauthorized @@ -534,7 +534,7 @@ PUT /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status }}">namespace -- **body**: }}">StatefulSet, required +- **body**: }}">StatefulSet, required @@ -558,9 +558,9 @@ PUT /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status #### Response -200 (}}">StatefulSet): OK +200 (}}">StatefulSet): OK -201 (}}">StatefulSet): Created +201 (}}">StatefulSet): Created 401: Unauthorized @@ -613,7 +613,7 @@ PATCH /apis/apps/v1/namespaces/{namespace}/statefulsets/{name} #### Response -200 (}}">StatefulSet): OK +200 (}}">StatefulSet): OK 401: Unauthorized @@ -666,7 +666,7 @@ PATCH /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status #### Response -200 (}}">StatefulSet): OK +200 (}}">StatefulSet): OK 401: Unauthorized diff --git a/content/en/docs/reference/kubernetes-api/workloads-resources/_index.md b/content/en/docs/reference/kubernetes-api/workloads-resources/_index.md deleted file mode 100644 index 1b5aab3fba..0000000000 --- a/content/en/docs/reference/kubernetes-api/workloads-resources/_index.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: "Workloads Resources" -weight: 1 ---- From 466b4bd8060291a2d1758de7ca30d29b4620a1a7 Mon Sep 17 00:00:00 2001 From: wasimj Date: Tue, 9 Mar 2021 14:17:05 +0000 Subject: [PATCH 006/104] Update server-side-apply.md Spelling mistake --- content/en/docs/reference/using-api/server-side-apply.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/reference/using-api/server-side-apply.md b/content/en/docs/reference/using-api/server-side-apply.md index d91497f8f2..0ef1c7a4c1 100644 --- a/content/en/docs/reference/using-api/server-side-apply.md +++ b/content/en/docs/reference/using-api/server-side-apply.md @@ -46,7 +46,7 @@ Server side apply is meant both as a replacement for the original `kubectl apply` and as a simpler mechanism for controllers to enact their changes. If you have Server Side Apply enabled, the control plane tracks managed fields -for all newlly created objects. +for all newly created objects. ## Field Management From 22f104c6c329dca97901ec1b453da0cba6147504 Mon Sep 17 00:00:00 2001 From: luzg Date: Wed, 10 Mar 2021 11:14:58 +0800 Subject: [PATCH 007/104] [zh] translate task/install kubectl on macOS --- .../tools/included/install-kubectl-gcloud.md | 37 +++ .../tools/included/kubectl-whats-next.md | 27 ++ .../optional-kubectl-configs-bash-mac.md | 173 ++++++++++++ .../included/optional-kubectl-configs-zsh.md | 50 ++++ .../tasks/tools/included/verify-kubectl.md | 62 +++++ .../docs/tasks/tools/install-kubectl-macos.md | 263 ++++++++++++++++++ 6 files changed, 612 insertions(+) create mode 100644 content/zh/docs/tasks/tools/included/install-kubectl-gcloud.md create mode 100644 content/zh/docs/tasks/tools/included/kubectl-whats-next.md create mode 100644 content/zh/docs/tasks/tools/included/optional-kubectl-configs-bash-mac.md create mode 100644 content/zh/docs/tasks/tools/included/optional-kubectl-configs-zsh.md create mode 100644 content/zh/docs/tasks/tools/included/verify-kubectl.md create mode 100644 content/zh/docs/tasks/tools/install-kubectl-macos.md diff --git a/content/zh/docs/tasks/tools/included/install-kubectl-gcloud.md b/content/zh/docs/tasks/tools/included/install-kubectl-gcloud.md new file mode 100644 index 0000000000..e73932851d --- /dev/null +++ b/content/zh/docs/tasks/tools/included/install-kubectl-gcloud.md @@ -0,0 +1,37 @@ +--- +title: "通过 gcloud 安装 kubectl" +description: "用各个特定操作系统标签页中包含的 gcloud 指令片段安装 kubectl。" +headless: true +--- + + + +kubectl 可以作为 Google Cloud SDK 的一部分被安装。 + + +1. 安装 [Google Cloud SDK](https://cloud.google.com/sdk/)。 +1. 运行安装 `kubectl` 的命令: + + ```shell + gcloud components install kubectl + ``` + + +1. 验证一下,确保安装的是最新的版本: + + ```shell + kubectl version --client + ``` \ No newline at end of file diff --git a/content/zh/docs/tasks/tools/included/kubectl-whats-next.md b/content/zh/docs/tasks/tools/included/kubectl-whats-next.md new file mode 100644 index 0000000000..3990922e0e --- /dev/null +++ b/content/zh/docs/tasks/tools/included/kubectl-whats-next.md @@ -0,0 +1,27 @@ +--- +title: "后续内容" +description: "安装 kubectl 之后,还可以做些什么?" +headless: true +--- + + + +* [安装 Minikube](https://minikube.sigs.k8s.io/docs/start/) +* 有关创建集群的更多信息,请参阅[入门指南](/zh/docs/setup/). +* [学习如何启动并对外公开你的应用程序。](/zh/docs/tasks/access-application-cluster/service-access-application-cluster/) +* 如果你需要访问其他人创建的集群,请参阅 + [共享集群接入文档](/zh/docs/tasks/access-application-cluster/configure-access-multiple-clusters/). +* 阅读 [kubectl 参考文档](/zh/docs/reference/kubectl/kubectl/) diff --git a/content/zh/docs/tasks/tools/included/optional-kubectl-configs-bash-mac.md b/content/zh/docs/tasks/tools/included/optional-kubectl-configs-bash-mac.md new file mode 100644 index 0000000000..d92055f6a3 --- /dev/null +++ b/content/zh/docs/tasks/tools/included/optional-kubectl-configs-bash-mac.md @@ -0,0 +1,173 @@ +--- +title: "macOS 系统上的 bash 自动补全" +description: "在 macOS 上实现 Bash 自动补全的一些可选配置。" +headless: true +--- + + + +### 简介 + + +kubectl 的 Bash 补全脚本可以通过 `kubectl completion bash` 命令生成。 +在你的 shell 中导入(Sourcing)这个脚本即可启用补全功能。 + +此外,kubectl 补全脚本依赖于工具 [**bash-completion**](https://github.com/scop/bash-completion), +所以你必须先安装它。 + +{{< warning>}} + +bash-completion 有两个版本:v1 和 v2。v1 对应 Bash3.2(也是 macOS 的默认安装版本),v2 对应 Bash 4.1+。 +kubectl 的补全脚本**无法适配** bash-completion v1 和 Bash 3.2。 +必须为它配备 **bash-completion v2** 和 **Bash 4.1+**。 +有鉴于此,为了在 macOS 上使用 kubectl 补全功能,你必须要安装和使用 Bash 4.1+ +([*说明*](https://itnext.io/upgrading-bash-on-macos-7138bd1066ba))。 +后续说明假定你用的是 Bash 4.1+(也就是 Bash 4.1 或更新的版本) +{{< /warning >}} + + +### 升级 Bash + + +后续说明假定你已使用 Bash 4.1+。你可以运行以下命令检查 Bash 版本: + +```bash +echo $BASH_VERSION +``` + + +如果版本太旧,可以用 Homebrew 安装/升级: + +```bash +brew install bash +``` + + +重新加载 shell,并验证所需的版本已经生效: + +```bash +echo $BASH_VERSION $SHELL +``` + + +Homebrew 通常把它安装为 `/usr/local/bin/bash`。 + + +### 安装 bash-completion + + +{{< note >}} + +如前所述,本说明假定你使用的 Bash 版本为 4.1+,这意味着你要安装 bash-completion v2 +(不同于 Bash 3.2 和 bash-completion v1,kubectl 的补全功能在该场景下无法工作)。 +{{< /note >}} + + +你可以用命令 `type _init_completion` 测试 bash-completion v2 是否已经安装。 +如未安装,用 Homebrew 来安装它: + +```bash +brew install bash-completion@2 +``` + + +如命令的输出信息所显示的,将如下内容添加到文件 `~/.bash_profile` 中: + +```bash +export BASH_COMPLETION_COMPAT_DIR="/usr/local/etc/bash_completion.d" +[[ -r "/usr/local/etc/profile.d/bash_completion.sh" ]] && . "/usr/local/etc/profile.d/bash_completion.sh" +``` + + +重新加载 shell,并用命令 `type _init_completion` 验证 bash-completion v2 已经恰当的安装。 + + +### 启用 kubectl 自动补全功能 + + +你现在需要确保在所有的 shell 环境中均已导入(sourced) kubectl 的补全脚本, +有若干种方法可以实现这一点: + +- 在文件 `~/.bash_profile` 中导入(Source)补全脚本: + + ```bash + echo 'source <(kubectl completion bash)' >>~/.bash_profile + ``` + + +- 将补全脚本添加到目录 `/usr/local/etc/bash_completion.d` 中: + + ```bash + kubectl completion bash >/usr/local/etc/bash_completion.d/kubectl + ``` + + +- 如果你为 kubectl 定义了别名,则可以扩展 shell 补全来兼容该别名: + + ```bash + echo 'alias k=kubectl' >>~/.bash_profile + echo 'complete -F __start_kubectl k' >>~/.bash_profile + ``` + + +- 如果你是用 Homebrew 安装的 kubectl([如上所述](#install-with-homebrew-on-macos)), + 那么 kubectl 补全脚本应该已经安装到目录 `/usr/local/etc/bash_completion.d/kubectl` 中了。 + 这种情况下,你什么都不需要做。 + + {{< note >}} + + 用 Hommbrew 安装的 bash-completion v2 会初始化 目录 `BASH_COMPLETION_COMPAT_DIR` 中的所有文件,这就是后两种方法能正常工作的原因。 + {{< /note >}} + + +总之,重新加载 shell 之后,kubectl 补全功能将立即生效。 diff --git a/content/zh/docs/tasks/tools/included/optional-kubectl-configs-zsh.md b/content/zh/docs/tasks/tools/included/optional-kubectl-configs-zsh.md new file mode 100644 index 0000000000..0f32593d55 --- /dev/null +++ b/content/zh/docs/tasks/tools/included/optional-kubectl-configs-zsh.md @@ -0,0 +1,50 @@ +--- +title: "zsh 自动补全" +description: "zsh 自动补全的一些可选配置" +headless: true +--- + + + +kubectl 通过命令 `kubectl completion zsh` 生成 Zsh 自动补全脚本。 +在 shell 中导入(Sourcing)该自动补全脚本,将启动 kubectl 自动补全功能。 + +为了在所有的 shell 会话中实现此功能,请将下面内容加入到文件 `~/.zshrc` 中。 + +```zsh +source <(kubectl completion zsh) +``` + + +如果你为 kubectl 定义了别名,可以扩展脚本补全,以兼容该别名。 + +```zsh +echo 'alias k=kubectl' >>~/.zshrc +echo 'complete -F __start_kubectl k' >>~/.zshrc +``` + + +重新加载 shell 后,kubectl 自动补全功能将立即生效。 + +如果你收到 `complete:13: command not found: compdef` 这样的错误提示,那请将下面内容添加到 `~/.zshrc` 文件的开头: + +```zsh +autoload -Uz compinit +compinit +``` diff --git a/content/zh/docs/tasks/tools/included/verify-kubectl.md b/content/zh/docs/tasks/tools/included/verify-kubectl.md new file mode 100644 index 0000000000..a587e26cd0 --- /dev/null +++ b/content/zh/docs/tasks/tools/included/verify-kubectl.md @@ -0,0 +1,62 @@ +--- +title: "验证 kubectl 的安装效果" +description: "如何验证 kubectl。" +headless: true +--- + + + +为了让 kubectl 能发现并访问 Kubernetes 集群,你需要一个 +[kubeconfig 文件](/docs/zh/concepts/configuration/organize-cluster-access-kubeconfig/), +该文件在 +[kube-up.sh](https://github.com/kubernetes/kubernetes/blob/master/cluster/kube-up.sh) +创建集群时,或成功部署一个 Miniube 集群时,均会自动生成。 +通常,kubectl 的配置信息存放于文件 `~/.kube/config` 中。 + +通过获取集群状态的方法,检查是否已恰当的配置了 kubectl: + +```shell +kubectl cluster-info +``` + + +如果返回一个 URL,则意味着 kubectl 成功的访问到了你的集群。 + +如果你看到如下所示的消息,则代表 kubectl 配置出了问题,或无法连接到 Kubernetes 集群。 + +``` +The connection to the server was refused - did you specify the right host or port? +(访问 被拒绝 - 你指定的主机和端口是否有误?) +``` + + +例如,如果你想在自己的笔记本上(本地)运行 Kubernetes 集群,你需要先安装一个 Minikube 这样的工具,然后再重新运行上面的命令。 + +如果命令 `kubectl cluster-info` 返回了 url,但你还不能访问集群,那可以用以下命令来检查配置是否妥当: + +```shell +kubectl cluster-info dump +``` \ No newline at end of file diff --git a/content/zh/docs/tasks/tools/install-kubectl-macos.md b/content/zh/docs/tasks/tools/install-kubectl-macos.md new file mode 100644 index 0000000000..bd5e670e86 --- /dev/null +++ b/content/zh/docs/tasks/tools/install-kubectl-macos.md @@ -0,0 +1,263 @@ +--- +title: 在 macOS 系统上安装和设置 kubectl +content_type: task +weight: 10 +card: + name: tasks + weight: 20 + title: 在 macOS 系统上安装 kubectl +--- + + +## {{% heading "prerequisites" %}} + + +kubectl 版本和集群之间的差异必须在一个小版本号之内。 +例如:v1.2 版本的客户端只能与 v1.1、v1.2 和 v1.3 版本的集群一起工作。 +用最新版本的 kubectl 有助于避免不可预见的问题。 + + +## 在 macOS 系统上安装 kubectl {#install-kubectl-on-macos} + + +在 macOS 系统上安装 kubectl 有如下方法: + +- [{{% heading "prerequisites" %}}](#{{% heading "prerequisites" %}}) +- [在 macOS 系统上安装 kubectl](#install-kubectl-on-macos) + - [用 curl 在 macOS 系统上安装 kubectl](#install-kubectl-binary-with-curl-on-macos) + - [用 Homebrew 在 macOS 系统上安装](#install-with-homebrew-on-macos) + - [用 Macports 在 macOS 上安装](#install-with-macports-on-macos) + - [作为谷歌云 SDK 的一部分,在 macOS 上安装](#install-on-macos-as-part-of-the-google-cloud-sdk) +- [验证 kubectl 配置](#verify-kubectl-configuration) +- [可选的 kubectl 配置](#optional-kubectl-configurations) + - [启用 shell 自动补全功能](#enable-shell-autocompletion) +- [{{% heading "whatsnext" %}}](#{{% heading "whatsnext" %}}) + + +### 用 curl 在 macOS 系统上安装 kubectl {#install-kubectl-binary-with-curl-on-macos} + + +1. 下载最新的发行版: + + ```bash + curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/darwin/amd64/kubectl" + ``` + + {{< note >}} + + 如果需要下载某个指定的版本,用该指定版本号替换掉命令的这个部分:`$(curl -L -s https://dl.k8s.io/release/stable.txt)`。 + 例如:要在 macOS 系统中下载 {{< param "fullversion" >}} 版本,则输入: + + ```bash + curl -LO https://dl.k8s.io/release/{{< param "fullversion" >}}/bin/darwin/amd64/kubectl + ``` + + {{< /note >}} + + +1. 验证可执行文件(可选操作) + + 下载 kubectl 的校验和文件: + + ```bash + curl -LO "https://dl.k8s.io/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/darwin/amd64/kubectl.sha256" + ``` + + + 根据校验和文件,验证 kubectl: + + ```bash + echo "$( + 验证通过时,输出如下: + + ```console + kubectl: OK + ``` + + + 验证失败时,`shasum` 将以非零值退出,并打印如下输出: + + ``` + kubectl: FAILED + shasum: WARNING: 1 computed checksum did NOT match + ``` + + {{< note >}} + + 下载的 kubectl 与校验和文件版本要相同。 + {{< /note >}} + + +1. 将 kubectl 置为可执行文件: + + ```bash + chmod +x ./kubectl + ``` + + +1. 将可执行文件 kubectl 移动到系统可寻址路径 `PATH` 内的一个位置: + + ```bash + sudo mv ./kubectl /usr/local/bin/kubectl + sudo chown root: /usr/local/bin/kubectl + ``` + + +1. 测试一下,确保你安装的是最新的版本: + + ```bash + kubectl version --client + ``` + + +### 用 Homebrew 在 macOS 系统上安装 {#install-with-homebrew-on-macos} + + +如果你是 macOS 系统,且用的是 [Homebrew](https://brew.sh/) 包管理工具, +则可以用 Homebrew 安装 kubectl。 + + +1. 运行安装命令: + + ```bash + brew install kubectl + ``` + + 或 + + ```bash + brew install kubernetes-cli + ``` + + +1. 测试一下,确保你安装的是最新的版本: + + ```bash + kubectl version --client + ``` + + +### 用 Macports 在 macOS 上安装 {#install-with-macports-on-macos} + + +如果你用的是 macOS,且用 [Macports](https://macports.org/) 包管理工具,则你可以用 Macports 安装kubectl。 + + +1. 运行安装命令: + + ```bash + sudo port selfupdate + sudo port install kubectl + ``` + + +1. 测试一下,确保你安装的是最新的版本: + + ```bash + kubectl version --client + ``` + + +### 作为谷歌云 SDK 的一部分,在 macOS 上安装 {#install-on-macos-as-part-of-the-google-cloud-sdk} + +{{< include "included/install-kubectl-gcloud.md" >}} + + +## 验证 kubectl 配置 {#verify-kubectl-configuration} + +{{< include "included/verify-kubectl.md" >}} + + +## 可选的 kubectl 配置 {#optional-kubectl-configurations} + +### 启用 shell 自动补全功能 {#enable-shell-autocompletion} + + +kubectl 为 Bash 和 Zsh 提供自动补全功能,这可以节省许多输入的麻烦。 + +下面是为 Bash 和 Zsh 设置自动补全功能的操作步骤。 + +{{< tabs name="kubectl_autocompletion" >}} +{{< tab name="Bash" include="included/optional-kubectl-configs-bash-mac.md" />}} +{{< tab name="Zsh" include="included/optional-kubectl-configs-zsh.md" />}} +{{< /tabs >}} + +## {{% heading "whatsnext" %}} + +{{< include "included/kubectl-whats-next.md" >}} \ No newline at end of file From 1ea5f5ee3168b0574cf4eac957fded24967c409d Mon Sep 17 00:00:00 2001 From: buptliuwei Date: Thu, 11 Mar 2021 11:58:00 +0800 Subject: [PATCH 008/104] fixed demo deployment create command when use `kubectl run source-ip-app --image=k8s.gcr.io/echoserver:1.4` . it will be create a pod, the output is: `pod/source-ip-app created`, but the svc will find `deployment` when use `kubectl expose deployment source-ip-app --name=clusterip --port=80 --target-port=8080` --- content/zh/docs/tutorials/services/source-ip.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/zh/docs/tutorials/services/source-ip.md b/content/zh/docs/tutorials/services/source-ip.md index 93c4711363..f989e93c70 100644 --- a/content/zh/docs/tutorials/services/source-ip.md +++ b/content/zh/docs/tutorials/services/source-ip.md @@ -35,7 +35,7 @@ Kubernetes 集群中运行的应用通过 Service 抽象来互相查找、通信 你必须拥有一个正常工作的 Kubernetes 1.5 集群来运行此文档中的示例。该示例使用一个简单的 nginx webserver,通过一个HTTP消息头返回它接收到请求的源IP。你可以像下面这样创建它: ```console -kubectl run source-ip-app --image=k8s.gcr.io/echoserver:1.4 +kubectl create deployment source-ip-app --image=k8s.gcr.io/echoserver:1.4 ``` 输出结果为 ``` From 40950997bee0d673f46cb810902ea8d09373324a Mon Sep 17 00:00:00 2001 From: Sergey Kanzhelev Date: Thu, 11 Mar 2021 17:19:23 -0800 Subject: [PATCH 009/104] Update content/en/docs/concepts/architecture/nodes.md Co-authored-by: Tim Bannister --- content/en/docs/concepts/architecture/nodes.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/docs/concepts/architecture/nodes.md b/content/en/docs/concepts/architecture/nodes.md index cd2c2291c5..11343a2d8a 100644 --- a/content/en/docs/concepts/architecture/nodes.md +++ b/content/en/docs/concepts/architecture/nodes.md @@ -71,7 +71,8 @@ The [name](/docs/concepts/overview/working-with-objects/names#names) identifies cannot have the same name at the same time. Kubernetes also assumes that a resource with the same name is the same object. In case of a Node, it is implicitly assumed that an instance using the same name will have the same state (e.g. network settings, root disk contents). This may lead to -inconsistencies if instance was altered without the change of a name or deleting and re-creating the +inconsistencies if you modify an instance without changing its name. If you want to replace a node, you should +make sure to remove the existing Node object from API server. {{< /note >}} @@ -367,4 +368,3 @@ For example, if `ShutdownGracePeriod=30s`, and `ShutdownGracePeriodCriticalPods= * Read the [Node](https://git.k8s.io/community/contributors/design-proposals/architecture/architecture.md#the-kubernetes-node) section of the architecture design document. * Read about [taints and tolerations](/docs/concepts/scheduling-eviction/taint-and-toleration/). - From b891ef312a38ca83ea997a9655ff8bb0d493339a Mon Sep 17 00:00:00 2001 From: CKchen0726 Date: Mon, 15 Mar 2021 15:53:16 +0800 Subject: [PATCH 010/104] [zh] fix spelling mistake in content/zh/docs/concepts/storage/storage-classes.md --- content/zh/docs/concepts/storage/storage-classes.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/content/zh/docs/concepts/storage/storage-classes.md b/content/zh/docs/concepts/storage/storage-classes.md index 3cffd19a17..57b58006b3 100644 --- a/content/zh/docs/concepts/storage/storage-classes.md +++ b/content/zh/docs/concepts/storage/storage-classes.md @@ -225,14 +225,14 @@ mount options specified in the `mountOptions` field of the class. If the volume plugin does not support mount options but mount options are specified, provisioning will fail. Mount options are not validated on either -the class or PV, so mount of the PV will simply fail if one is invalid. +the class or PV, If a mount option is invalid, the PV mount fails. --> ### 挂载选项 由 StorageClass 动态创建的 PersistentVolume 将使用类中 `mountOptions` 字段指定的挂载选项。 -如果卷插件不支持挂载选项,却指定了该选项,则制备操作会失败。 -挂载选项在 StorageClass 和 PV 上都不会做验证,所以如果挂载选项无效,那么这个 PV 就会失败。 +如果卷插件不支持挂载选项,却指定了选项,则制备操作会失败。 +挂载选项在 StorageClass 和 PV 上都不会做验证,如果其中一个挂载选项无效,那么这个 PV 挂载就会失败。 -* 一台或多台运行着下列系统的机器: - - Ubuntu 16.04+ - - Debian 9+ - - CentOS 7+ - - Red Hat Enterprise Linux (RHEL) 7+ - - Fedora 25+ - - HypriotOS v1.0.1+ - - Flatcar Container Linux (使用 2512.3.0 版本测试通过) +* 一台兼容的 Linux 主机。Kubernetes 项目为基于 Debian 和 Red Hat 的 Linux + 发行版以及一些不提供包管理器的发行版提供通用的指令 * 每台机器 2 GB 或更多的 RAM (如果少于这个数字将会影响你应用的运行内存) * 2 CPU 核或更多 * 集群中的所有机器的网络彼此均能相互连接(公网和内网都可以) @@ -211,7 +198,7 @@ The following table lists container runtimes and their associated socket paths: | Runtime | Domain Socket | |------------|---------------------------------| -| Docker | /var/run/docker.sock | +| Docker | /var/run/dockershim.sock | | containerd | /run/containerd/containerd.sock | | CRI-O | /var/run/crio/crio.sock | --> @@ -225,7 +212,7 @@ The following table lists container runtimes and their associated socket paths: | 运行时 | 域套接字 | |------------|----------------------------------| -| Docker | /var/run/docker.sock | +| Docker | /var/run/dockershim.sock | | containerd | /run/containerd/containerd.sock | | CRI-O | /var/run/crio/crio.sock | @@ -289,7 +276,7 @@ kubelet and the control plane is supported, but the kubelet version may never ex server version. For example, kubelets running 1.7.0 should be fully compatible with a 1.8.0 API server, but not vice versa. -For information about installing `kubectl`, see [Install and set up kubectl](/docs/tasks/tools/install-kubectl/). +For information about installing `kubectl`, see [Install and set up kubectl](/docs/tasks/tools/). --> ## 安装 kubeadm、kubelet 和 kubectl @@ -308,7 +295,7 @@ kubeadm **不能** 帮你安装或者管理 `kubelet` 或 `kubectl`,所以你 的版本不可以超过 API 服务器的版本。 例如,1.7.0 版本的 kubelet 可以完全兼容 1.8.0 版本的 API 服务器,反之则不可以。 -有关安装 `kubectl` 的信息,请参阅[安装和设置 kubectl](/zh/docs/tasks/tools/install-kubectl/)文档。 +有关安装 `kubectl` 的信息,请参阅[安装和设置 kubectl](/zh/docs/tasks/tools/)文档。 {{< warning >}} +1. 更新 `apt` 包索引并安装使用 Kubernetes `apt` 仓库所需要的包: + + ```shell + sudo apt-get update + sudo apt-get install -y apt-transport-https ca-certificates curl + ``` + + +2. 下载 Google Cloud 公开签名秘钥: + + ```shell + sudo curl -fsSLo /usr/share/keyrings/kubernetes-archive-keyring.gpg https://packages.cloud.google.com/apt/doc/apt-key.gpg + ``` + + +3. 添加 Kubernetes `apt` 仓库: + + ```shell + echo "deb [signed-by=/usr/share/keyrings/kubernetes-archive-keyring.gpg] https://apt.kubernetes.io/ kubernetes-xenial main" | sudo tee /etc/apt/sources.list.d/kubernetes.list + ``` + + +4. 更新 `apt` 包索引,安装 kubelet、kubeadm 和 kubectl,并锁定其版本: + + ```shell + sudo apt-get update + sudo apt-get install -y kubelet kubeadm kubectl + sudo apt-mark hold kubelet kubeadm kubectl + ``` {{% /tab %}} -{{% tab name="CentOS、RHEL 或 Fedora" %}} +{{% tab name="基于 Red Hat 的发行版" %}} ```bash cat <}} -DOWNLOAD_DIR 变量必须被设置为一个可写入的目录。 -如果你在运行 Flatcar Container Linux,可将 DOWNLOAD_DIR 设置为 /opt/bin。 +`DOWNLOAD_DIR` 变量必须被设置为一个可写入的目录。 +如果你在运行 Flatcar Container Linux,可将 `DOWNLOAD_DIR` 设置为 `/opt/bin`。 {{< /note >}} ```bash @@ -531,16 +546,6 @@ or `/etc/default/kubelet`(`/etc/sysconfig/kubelet` for RPMs), please remove it a `/var/lib/kubelet/config.yaml` 文件中)。 {{< /note >}} - -需要重新启动 kubelet: - -```bash -sudo systemctl daemon-reload -sudo systemctl restart kubelet -``` - -You can constrain a {{< glossary_tooltip text="Pod" term_id="pod" >}} to only be able to run on particular -{{< glossary_tooltip text="Node(s)" term_id="node" >}}, or to prefer to run on particular nodes. -There are several ways to do this, and the recommended approaches all use -[label selectors](/docs/concepts/overview/working-with-objects/labels/) to make the selection. +You can constrain a {{< glossary_tooltip text="Pod" term_id="pod" >}} so that it can only run on particular set of +{{< glossary_tooltip text="Node(s)" term_id="node" >}}. +There are several ways to do this and the recommended approaches all use +[label selectors](/docs/concepts/overview/working-with-objects/labels/) to facilitate the selection. Generally such constraints are unnecessary, as the scheduler will automatically do a reasonable placement -(e.g. spread your pods across nodes, not place the pod on a node with insufficient free resources, etc.) -but there are some circumstances where you may want more control on a node where a pod lands, for example to ensure +(e.g. spread your pods across nodes so as not place the pod on a node with insufficient free resources, etc.) +but there are some circumstances where you may want to control which node the pod deploys to - for example to ensure that a pod ends up on a machine with an SSD attached to it, or to co-locate pods from two different services that communicate a lot into the same availability zone. - ## nodeSelector From 64c16a5836853e8df5e37226a842c9b5b299cd01 Mon Sep 17 00:00:00 2001 From: Peri Thompson Date: Fri, 19 Mar 2021 18:40:30 +0000 Subject: [PATCH 020/104] Updated Windows doc reviewers --- .../windows/intro-windows-in-kubernetes.md | 6 ++++-- .../windows/user-guide-windows-containers.md | 6 ++++-- .../administer-cluster/kubeadm/adding-windows-nodes.md | 6 ++++-- 3 files changed, 12 insertions(+), 6 deletions(-) diff --git a/content/en/docs/setup/production-environment/windows/intro-windows-in-kubernetes.md b/content/en/docs/setup/production-environment/windows/intro-windows-in-kubernetes.md index 5c33b0a94b..a941c785e3 100644 --- a/content/en/docs/setup/production-environment/windows/intro-windows-in-kubernetes.md +++ b/content/en/docs/setup/production-environment/windows/intro-windows-in-kubernetes.md @@ -1,7 +1,9 @@ --- reviewers: -- michmike -- patricklang +- jayunit100 +- jsturtevant +- marosset +- perithompson title: Intro to Windows support in Kubernetes content_type: concept weight: 65 diff --git a/content/en/docs/setup/production-environment/windows/user-guide-windows-containers.md b/content/en/docs/setup/production-environment/windows/user-guide-windows-containers.md index 9133a2de1b..ce7aee8a89 100644 --- a/content/en/docs/setup/production-environment/windows/user-guide-windows-containers.md +++ b/content/en/docs/setup/production-environment/windows/user-guide-windows-containers.md @@ -1,7 +1,9 @@ --- reviewers: -- michmike -- patricklang +- jayunit100 +- jsturtevant +- marosset +- perithompson title: Guide for scheduling Windows containers in Kubernetes content_type: concept weight: 75 diff --git a/content/en/docs/tasks/administer-cluster/kubeadm/adding-windows-nodes.md b/content/en/docs/tasks/administer-cluster/kubeadm/adding-windows-nodes.md index 2f23379400..aad5f13909 100644 --- a/content/en/docs/tasks/administer-cluster/kubeadm/adding-windows-nodes.md +++ b/content/en/docs/tasks/administer-cluster/kubeadm/adding-windows-nodes.md @@ -1,7 +1,9 @@ --- reviewers: -- michmike -- patricklang +- jayunit100 +- jsturtevant +- marosset +- perithompson title: Adding Windows nodes min-kubernetes-server-version: 1.17 content_type: tutorial From 918ac7ecae86084d35a130c543b68f5b06bc6ae4 Mon Sep 17 00:00:00 2001 From: Jihoon Seo Date: Mon, 22 Mar 2021 11:09:30 +0900 Subject: [PATCH 021/104] [ko] Update link href to translated page --- .../reference/setup-tools/kubeadm/_index.md | 18 +++++++++--------- .../setup-tools/kubeadm/generated/_index.md | 6 ++++++ content/ko/docs/reference/tools.md | 2 +- .../container-runtimes.md | 2 +- content/ko/docs/tasks/tools/_index.md | 4 ++-- 5 files changed, 19 insertions(+), 13 deletions(-) create mode 100644 content/ko/docs/reference/setup-tools/kubeadm/generated/_index.md diff --git a/content/ko/docs/reference/setup-tools/kubeadm/_index.md b/content/ko/docs/reference/setup-tools/kubeadm/_index.md index 683f78000b..9211da1e0f 100644 --- a/content/ko/docs/reference/setup-tools/kubeadm/_index.md +++ b/content/ko/docs/reference/setup-tools/kubeadm/_index.md @@ -16,15 +16,15 @@ kubeadm은 실행 가능한 최소 클러스터를 시작하고 실행하는 데 ## 설치 방법 -kubeadm을 설치하려면, [설치 가이드](/docs/setup/production-environment/tools/kubeadm/install-kubeadm)를 참고한다. +kubeadm을 설치하려면, [설치 가이드](/ko/docs/setup/production-environment/tools/kubeadm/install-kubeadm/)를 참고한다. ## {{% heading "whatsnext" %}} -* [kubeadm init](/docs/reference/setup-tools/kubeadm/kubeadm-init): 쿠버네티스 컨트롤 플레인 노드를 부트스트랩한다. -* [kubeadm join](/docs/reference/setup-tools/kubeadm/kubeadm-join): 쿠버네티스 워커(worker) 노드를 부트스트랩하고 클러스터에 조인시킨다. -* [kubeadm upgrade](/docs/reference/setup-tools/kubeadm/kubeadm-upgrade): 쿠버네티스 클러스터를 새로운 버전으로 업그레이드한다. -* [kubeadm config](/docs/reference/setup-tools/kubeadm/kubeadm-config): kubeadm v1.7.x 이하의 버전을 사용하여 클러스터를 초기화한 경우, `kubeadm upgrade` 를 위해 사용자의 클러스터를 구성한다. -* [kubeadm token](/docs/reference/setup-tools/kubeadm/kubeadm-token): `kubeadm join` 을 위한 토큰을 관리한다. -* [kubeadm reset](/docs/reference/setup-tools/kubeadm/kubeadm-reset): `kubeadm init` 또는 `kubeadm join` 에 의한 호스트의 모든 변경 사항을 되돌린다. -* [kubeadm version](/docs/reference/setup-tools/kubeadm/kubeadm-version): kubeadm 버전을 출력한다. -* [kubeadm alpha](/docs/reference/setup-tools/kubeadm/kubeadm-alpha): 커뮤니티에서 피드백을 수집하기 위해서 기능 미리 보기를 제공한다. +* [kubeadm init](/docs/reference/setup-tools/kubeadm/kubeadm-init/): 쿠버네티스 컨트롤 플레인 노드를 부트스트랩한다. +* [kubeadm join](/docs/reference/setup-tools/kubeadm/kubeadm-join/): 쿠버네티스 워커(worker) 노드를 부트스트랩하고 클러스터에 조인시킨다. +* [kubeadm upgrade](/docs/reference/setup-tools/kubeadm/kubeadm-upgrade/): 쿠버네티스 클러스터를 새로운 버전으로 업그레이드한다. +* [kubeadm config](/docs/reference/setup-tools/kubeadm/kubeadm-config/): kubeadm v1.7.x 이하의 버전을 사용하여 클러스터를 초기화한 경우, `kubeadm upgrade` 를 위해 사용자의 클러스터를 구성한다. +* [kubeadm token](/docs/reference/setup-tools/kubeadm/kubeadm-token/): `kubeadm join` 을 위한 토큰을 관리한다. +* [kubeadm reset](/docs/reference/setup-tools/kubeadm/kubeadm-reset/): `kubeadm init` 또는 `kubeadm join` 에 의한 호스트의 모든 변경 사항을 되돌린다. +* [kubeadm version](/docs/reference/setup-tools/kubeadm/kubeadm-version/): kubeadm 버전을 출력한다. +* [kubeadm alpha](/docs/reference/setup-tools/kubeadm/kubeadm-alpha/): 커뮤니티에서 피드백을 수집하기 위해서 기능 미리 보기를 제공한다. diff --git a/content/ko/docs/reference/setup-tools/kubeadm/generated/_index.md b/content/ko/docs/reference/setup-tools/kubeadm/generated/_index.md new file mode 100644 index 0000000000..7ebf753ae9 --- /dev/null +++ b/content/ko/docs/reference/setup-tools/kubeadm/generated/_index.md @@ -0,0 +1,6 @@ +--- +title: "Kubeadm Generated" +weight: 10 +toc_hide: true +--- + diff --git a/content/ko/docs/reference/tools.md b/content/ko/docs/reference/tools.md index 97206f3be7..a38158bf14 100644 --- a/content/ko/docs/reference/tools.md +++ b/content/ko/docs/reference/tools.md @@ -16,7 +16,7 @@ content_type: concept ## Kubeadm -[`kubeadm`](/docs/setup/production-environment/tools/kubeadm/install-kubeadm/)은 물리적 환경, 클라우드 서버, 또는 가상머신 상에서 안전한 쿠버네티스를 쉽게 프로비저닝하기 위한 커맨드라인 툴이다(현재는 알파 상태). +[`kubeadm`](/ko/docs/setup/production-environment/tools/kubeadm/install-kubeadm/)은 물리적 환경, 클라우드 서버, 또는 가상머신 상에서 안전한 쿠버네티스를 쉽게 프로비저닝하기 위한 커맨드라인 툴이다(현재는 알파 상태). ## Minikube diff --git a/content/ko/docs/setup/production-environment/container-runtimes.md b/content/ko/docs/setup/production-environment/container-runtimes.md index 827b407b84..ba06b3d023 100644 --- a/content/ko/docs/setup/production-environment/container-runtimes.md +++ b/content/ko/docs/setup/production-environment/container-runtimes.md @@ -265,7 +265,7 @@ Start-Service containerd ``` kubeadm을 사용하는 경우, -[kubelet용 cgroup 드라이버](/docs/setup/production-environment/tools/kubeadm/install-kubeadm/#configure-cgroup-driver-used-by-kubelet-on-control-plane-node)를 수동으로 구성한다. +[kubelet용 cgroup 드라이버](/ko/docs/setup/production-environment/tools/kubeadm/install-kubeadm/#컨트롤-플레인-노드에서-kubelet이-사용하는-cgroup-드라이버-구성)를 수동으로 구성한다. ### CRI-O diff --git a/content/ko/docs/tasks/tools/_index.md b/content/ko/docs/tasks/tools/_index.md index 47c90ec7fd..8c2b3e1aed 100755 --- a/content/ko/docs/tasks/tools/_index.md +++ b/content/ko/docs/tasks/tools/_index.md @@ -53,7 +53,7 @@ kind를 시작하고 실행하기 위해 수행해야 하는 작업을 보여준 {{< glossary_tooltip term_id="kubeadm" text="kubeadm" >}} 도구를 사용하여 쿠버네티스 클러스터를 만들고 관리할 수 있다. 사용자 친화적인 방식으로 최소한의 실행 가능하고 안전한 클러스터를 설정하고 실행하는 데 필요한 작업을 수행한다. -[kubeadm 설치](/docs/setup/production-environment/tools/kubeadm/install-kubeadm/) 페이지는 kubeadm 설치하는 방법을 보여준다. +[kubeadm 설치](/ko/docs/setup/production-environment/tools/kubeadm/install-kubeadm/) 페이지는 kubeadm 설치하는 방법을 보여준다. 설치가 끝나면, [클러스터 생성](/docs/setup/production-environment/tools/kubeadm/create-cluster-kubeadm/)이 가능하다. -kubeadm 설치 가이드 보기 +kubeadm 설치 가이드 보기 From f755079d155f9dc8b1b4380a77c5a8f60d5eb857 Mon Sep 17 00:00:00 2001 From: Arhell Date: Tue, 23 Mar 2021 00:22:35 +0200 Subject: [PATCH 022/104] [ja] fix column alignment --- .../ja/docs/tasks/debug-application-cluster/debug-service.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/ja/docs/tasks/debug-application-cluster/debug-service.md b/content/ja/docs/tasks/debug-application-cluster/debug-service.md index 5daefb2f59..fa8ce7109b 100644 --- a/content/ja/docs/tasks/debug-application-cluster/debug-service.md +++ b/content/ja/docs/tasks/debug-application-cluster/debug-service.md @@ -365,7 +365,7 @@ kubectl get service hostnames -o json kubectl get pods -l app=hostnames ``` ```none -NAME READY STATUS RESTARTS AGE +NAME READY STATUS RESTARTS AGE hostnames-632524106-bbpiw 1/1 Running 0 1h hostnames-632524106-ly40y 1/1 Running 0 1h hostnames-632524106-tlaok 1/1 Running 0 1h From f2657734f89c0319dcbf7c8af2a27057ccf7de4c Mon Sep 17 00:00:00 2001 From: Giyoon Park <74027224+pgy11@users.noreply.github.com> Date: Wed, 24 Mar 2021 23:20:01 +0900 Subject: [PATCH 023/104] ko: fix typo in content/ko/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume.md This PR fixes typo --- .../stateful-application/mysql-wordpress-persistent-volume.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/ko/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume.md b/content/ko/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume.md index 5c27b55183..fd893ca5de 100644 --- a/content/ko/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume.md +++ b/content/ko/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume.md @@ -91,7 +91,7 @@ EOF ## MySQL과 WordPress에 필요한 리소스 구성 추가하기 -다음 매니페스트는 MySQL 디플로이먼트 단일 인스턴스를 기술한다. MySQL 컨케이너는 퍼시스턴트볼륨을 /var/lib/mysql에 마운트한다. `MYSQL_ROOT_PASSWORD` 환경변수는 시크릿에서 가져와 데이터베이스 암호로 설정한다. +다음 매니페스트는 MySQL 디플로이먼트 단일 인스턴스를 기술한다. MySQL 컨테이너는 퍼시스턴트볼륨을 /var/lib/mysql에 마운트한다. `MYSQL_ROOT_PASSWORD` 환경변수는 시크릿에서 가져와 데이터베이스 암호로 설정한다. {{< codenew file="application/wordpress/mysql-deployment.yaml" >}} From 8d7396eb147caccd88e80e8ee4b5ba4d381768f1 Mon Sep 17 00:00:00 2001 From: "M. Habib Rosyad" Date: Thu, 25 Mar 2021 13:42:12 +0800 Subject: [PATCH 024/104] id: sync task-tutorial-prereqs.md --- content/id/includes/task-tutorial-prereqs.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/content/id/includes/task-tutorial-prereqs.md b/content/id/includes/task-tutorial-prereqs.md index 3c8abb5b09..5afea1cb95 100644 --- a/content/id/includes/task-tutorial-prereqs.md +++ b/content/id/includes/task-tutorial-prereqs.md @@ -1,8 +1,8 @@ -Kamu harus memiliki klaster Kubernetes, dan perangkat baris perintah `kubectl` -juga harus dikonfigurasikan untuk berkomunikasi dengan klaster kamu. Jika kamu -belum punya klaster, kamu dapat membuatnya dengan menggunakan -[Minikube](/docs/setup/learning-environment/minikube/), -atau kamu dapat menggunakan salah satu tempat bermain Kubernetes ini: +Kamu harus memiliki klaster Kubernetes, dan perangkat baris perintah kubectl +juga harus dikonfigurasikan untuk berkomunikasi dengan klastermu. Jika kamu +belum memiliki klaster, kamu dapat membuatnya dengan menggunakan +[minikube](/id/docs/tasks/tools/#minikube), +atau kamu juga dapat menggunakan salah satu dari tempat mencoba Kubernetes berikut ini: * [Katacoda](https://www.katacoda.com/courses/kubernetes/playground) * [Bermain dengan Kubernetes](http://labs.play-with-k8s.com/) From 1abf84e7cd4e5a304d8e207a07b06d49bd64a61b Mon Sep 17 00:00:00 2001 From: "M. Habib Rosyad" Date: Thu, 25 Mar 2021 13:55:28 +0800 Subject: [PATCH 025/104] id: sync supported-doc-versions.md --- .../id/docs/home/supported-doc-versions.md | 29 ++++--------------- 1 file changed, 6 insertions(+), 23 deletions(-) diff --git a/content/id/docs/home/supported-doc-versions.md b/content/id/docs/home/supported-doc-versions.md index 6cecfdaec1..c28dec9fab 100644 --- a/content/id/docs/home/supported-doc-versions.md +++ b/content/id/docs/home/supported-doc-versions.md @@ -1,29 +1,12 @@ --- -title: Versi Kubernetes yang Termasuk dalam Dokumentasi -content_type: concept +title: Versi Dokumentasi yang Tersedia +content_type: custom +layout: supported-versions card: name: about weight: 10 - title: Versi Kubernetes yang Termasuk dalam Dokumentasi + title: Versi Dokumentasi yang Tersedia --- - - -Situs ini merupakan dokumentasi dari Kubernetes versi saat ini dan 4 versi sebelumnya. - - - - - -## Versi saat ini - -Versi saat ini adalah -[{{< param "version" >}}](/). - -## Versi sebelumnya - -{{< versions-other >}} - - - - +Situs web ini berisi dokumentasi untuk versi terkini Kubernetes +dan empat versi sebelumnya. From eb9ea620416b76c89fd3ead9bde2f05cbf740017 Mon Sep 17 00:00:00 2001 From: "M. Habib Rosyad" Date: Thu, 25 Mar 2021 09:15:02 +0800 Subject: [PATCH 026/104] id: move monitoring.md to system-metrics.md and sync with upstream --- .../cluster-administration/monitoring.md | 168 ------------------ .../cluster-administration/system-metrics.md | 166 +++++++++++++++++ 2 files changed, 166 insertions(+), 168 deletions(-) delete mode 100644 content/id/docs/concepts/cluster-administration/monitoring.md create mode 100644 content/id/docs/concepts/cluster-administration/system-metrics.md diff --git a/content/id/docs/concepts/cluster-administration/monitoring.md b/content/id/docs/concepts/cluster-administration/monitoring.md deleted file mode 100644 index f4917496a9..0000000000 --- a/content/id/docs/concepts/cluster-administration/monitoring.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -title: Metrik-Metrik untuk Control Plane Kubernetes -content_type: concept -weight: 60 -aliases: -- controller-metrics.md ---- - - - -Metrik dari komponen sistem dapat memberikan pandangan yang lebih baik tentang apa -yang sedang terjadi di dalam sistem. Metrik sangat berguna untuk membuat dasbor (_dashboard_) -dan peringatan (_alert_). - -Metrik di dalam _control plane_ Kubernetes disajikan dalam [format prometheus](https://prometheus.io/docs/instrumenting/exposition_formats/) -dan dapat terbaca oleh manusia. - - - - - -## Metrik-Metrik pada Kubernetes - -Dalam kebanyakan kasus, metrik tersedia pada _endpoint_ `/metrics` dari server HTTP. -Untuk komponen yang tidak mengekspos _endpoint_ secara bawaan, _endpoint_ tersebut dapat diaktifkan -dengan menggunakan opsi `--bind-address`. - -Contoh-contoh untuk komponen tersebut adalah: - -* {{< glossary_tooltip term_id="kube-controller-manager" text="kube-controller-manager" >}} -* {{< glossary_tooltip term_id="kube-proxy" text="kube-proxy" >}} -* {{< glossary_tooltip term_id="kube-apiserver" text="kube-apiserver" >}} -* {{< glossary_tooltip term_id="kube-scheduler" text="kube-scheduler" >}} -* {{< glossary_tooltip term_id="kubelet" text="kubelet" >}} - -Di dalam lingkungan produksi, kamu mungkin ingin mengonfigurasi [Server Prometheus](https://prometheus.io/) -atau _scraper_ metrik (pengambil metrik) lainnya untuk mengumpulkan metrik-metrik ini secara berkala -dan membuatnya tersedia dalam semacam basis data yang _time series_. - -Perlu dicatat bahwa {{< glossary_tooltip term_id="kubelet" text="kubelet" >}} -juga mengekspos metrik pada _endpoint-endpoint_ seperti `/metrics/cadvisor`, -`/metrics/resource` dan `/metrics/probes`. Metrik-metrik tersebut tidak memiliki -siklus hidup yang sama. - -Jika klaster kamu menggunakan {{< glossary_tooltip term_id="rbac" text="RBAC" >}}, -untuk membaca metrik memerlukan otorisasi melalui sebuah User, Group, atau -ServiceAccount dengan ClusterRole yang memperbolehkan mengakses `/metrics`. - -Sebagai contoh: - -``` -apiVersion: rbac.authorization.k8s.io/v1 -kind: ClusterRole -metadata: - name: prometheus -rules: - - nonResourceURLs: - - "/metrics" - verbs: - - get -``` - -## Siklus Hidup (_Lifecycle_) Metrik - -Alpha metric → Stable metric → Deprecated metric → Hidden metric → Deletion - -Metrik-metrik _Alpha_ tidak memiliki jaminan stabilitas; dengan demikian mereka -dapat dimodifikasi atau dihapus kapan saja. - -Metrik-metrik _Stable_ dijamin tidak berubah (dijamin stabilitasnya); Secara khusus, stabilitas berarti: - -* metrik itu sendiri tidak akan dihapus (atau diganti namanya) -* jenis metrik tidak akan dimodifikasi - -Metrik _Deprecated_ memberi penanda bahwa metrik tersebut suatu saat akan dihapus; untuk -menemukan versi yang mana, kamu perlu memeriksa anotasi, yang mencakup dari versi -Kubernetes mana yang metrik tersebut akan dianggap _deprecated_. - -Sebelum _deprecation_: - -``` -# HELP some_counter this counts things -# TYPE some_counter counter -some_counter 0 -``` - -Sesudah _deprecation_: - -``` -# HELP some_counter (Deprecated since 1.15.0) this counts things -# TYPE some_counter counter -some_counter 0 -``` - -Setelah metrik disembunyikan maka secara bawaan metrik tidak dipublikasikan -untuk _scraping_ (pengambilan metrik). Untuk menggunakan metrik yang tersembunyi, kamu perlu mengganti (_override_) -konfigurasi untuk komponen klaster yang relevan. - -Setelah metrik dihapus, metrik tidak dipublikasikan. Kamu tidak dapat mengubah -metrik tersebut dengan menggunakan _override_. - -## Melihat Metrik tersembunyi - -Seperti dijelaskan di atas, para admin dapat mengaktifkan metrik tersembunyi -melalui opsi pada baris perintah (_command line_) untuk _binary_ (program) tertentu. Ini ditujukan untuk -digunakan sebagai solusi bagi para admin apabila mereka gagal memigrasi -metrik yang sudah _deprecated_ dalam rilis terakhir. - -Opsi `show-hidden-metrics-for-version` menunjukkan versi yang ingin kamu tampilkan -metrik yang sudah _deprecated_ dalam rilis tersebut. Versi ini ditampilkan dalam bentuk x.y, -di mana x adalah versi _major_, y ​​adalah versi minor. Versi _patch_ tidak -diperlukan meskipun metrik dapat di_-deprecate_ dalam rilis _patch_, hal ini -adalah karena kebijakan _deprecation_ untuk metrik hanya berlaku terhadap rilis minor. - -Opsi tersebut hanya dapat menggunakan versi minor sebelumnya sebagai parameternya. Semua -metrik yang disembunyikan di versi sebelumnya akan dikeluarkan jika para admin -mengatur versi sebelumnya ke `show-hidden-metrics-for-version`. Versi yang -terlalu lama tidak diizinkan karena hal ini melanggar kebijakan untuk metrik yang -sudah _deprecated_. - -Ambil metrik `A` sebagai contoh, di sini diasumsikan bahwa `A` sudah _deprecated_ -pada rilis 1.n. Menurut kebijakan metrik yang sudah _deprecated_, kita dapat mencapai kesimpulan -sebagai berikut: - -* Pada rilis `1.n`, metrik sudah di_-deprecated_, dan dapat diperlihatkan secara bawaan. -* Pada rilis `1.n + 1`, metrik disembunyikan secara bawaan dan dapat - diperlihatkan dengan baris perintah `show-hidden-metrics-for-version=1.n`. -* Pada rilis `1.n + 2`, metrik harus dihapus dari _codebase_. Tidak ada jalan - keluar lagi. - -Jika kamu meng-_upgrade_ dari rilis `1.12` ke` 1.13`, tetapi masih bergantung pada -metrik `A` yang di-_deprecate_ dalam` 1.12`, kamu harus mengatur metrik -tersembunyi melalui baris perintah: `--show-hidden-metrics=1.12` dan ingatlah -untuk menghapus ketergantungan terhadap metrik ini sebelum meng-_upgrade_ ke `1.14`. - -## Metrik komponen - -### Metrik kube-controller-manager - -Metrik Controller Manager memberikan pandangan penting -tentang kinerja dan kesehatan Controller Manager. Metrik ini mencakup metrik -_runtime_ berbahasa Go yang umum seperti jumlah _go_routine_ dan metrik khusus -pengontrol seperti latensi _request etcd_ atau latensi API dari Cloud provider -(AWS, GCE, OpenStack) yang dapat digunakan untuk mengukur kesehatan klaster. - -Mulai dari Kubernetes 1.7, metrik Cloud provider yang detail tersedia untuk -operasi penyimpanan untuk GCE, AWS, Vsphere, dan OpenStack. -Metrik ini dapat digunakan untuk memantau kesehatan operasi PersistentVolume. - -Misalnya, untuk GCE metrik tersebut adalah: - -``` -cloudprovider_gce_api_request_duration_seconds { request = "instance_list"} -cloudprovider_gce_api_request_duration_seconds { request = "disk_insert"} -cloudprovider_gce_api_request_duration_seconds { request = "disk_delete"} -cloudprovider_gce_api_request_duration_seconds { request = "attach_disk"} -cloudprovider_gce_api_request_duration_seconds { request = "detach_disk"} -cloudprovider_gce_api_request_duration_seconds { request = "list_disk"} -``` - - - -## {{% heading "whatsnext" %}} - -* Baca tentang [format teks Prometheus](https://github.com/prometheus/docs/blob/master/content/docs/instrumenting/exposition_formats.md#text-based-format) untuk berbagai metrik -* Lihat daftar [metrik Kubernetes yang _stable_](https://github.com/kubernetes/kubernetes/blob/master/test/instrumentation/testdata/stable-metrics-list.yaml) -* Baca tentang [kebijakan _deprecation_ Kubernetes](https://kubernetes.io/docs/reference/using-api/deprecation-policy/#deprecating-a-feature-or-behavior ) - diff --git a/content/id/docs/concepts/cluster-administration/system-metrics.md b/content/id/docs/concepts/cluster-administration/system-metrics.md new file mode 100644 index 0000000000..f731ccfd77 --- /dev/null +++ b/content/id/docs/concepts/cluster-administration/system-metrics.md @@ -0,0 +1,166 @@ +--- +title: Metrik untuk Komponen Sistem Kubernetes +content_type: concept +weight: 60 +--- + + + +Metrik dari komponen sistem dapat memberikan gambaran yang lebih baik tentang apa +yang sedang terjadi di dalam sistem. Metrik sangat berguna untuk membuat dasbor (_dashboard_) +dan peringatan (_alert_). + +Komponen Kubernetes mengekspos metrik dalam [format Prometheus](https://prometheus.io/docs/instrumenting/exposition_formats/). +Format ini berupa teks biasa yang terstruktur, dirancang agar orang dan mesin dapat membacanya. + + + +## Metrik-metrik dalam Kubernetes + +Dalam kebanyakan kasus, metrik tersedia pada _endpoint_ `/metrics` dari server HTTP. +Untuk komponen yang tidak mengekspos _endpoint_ secara bawaan, _endpoint_ tersebut dapat diaktifkan +dengan menggunakan opsi `--bind-address`. + +Contoh-contoh untuk komponen tersebut adalah: + +* {{< glossary_tooltip term_id="kube-controller-manager" text="kube-controller-manager" >}} +* {{< glossary_tooltip term_id="kube-proxy" text="kube-proxy" >}} +* {{< glossary_tooltip term_id="kube-apiserver" text="kube-apiserver" >}} +* {{< glossary_tooltip term_id="kube-scheduler" text="kube-scheduler" >}} +* {{< glossary_tooltip term_id="kubelet" text="kubelet" >}} + +Di dalam lingkungan produksi, kamu mungkin ingin mengonfigurasi [Server Prometheus](https://prometheus.io/) +atau pengambil metrik (_metrics scraper_) lainnya untuk mengumpulkan metrik-metrik ini secara berkala +dan membuatnya tersedia dalam semacam pangkalan data deret waktu (_time series database_). + +Perlu dicatat bahwa {{< glossary_tooltip term_id="kubelet" text="kubelet" >}} +juga mengekspos metrik pada _endpoint-endpoint_ seperti `/metrics/cadvisor`, +`/metrics/resource` dan `/metrics/probes`. Metrik-metrik tersebut tidak memiliki +siklus hidup yang sama. + +Jika klastermu menggunakan {{< glossary_tooltip term_id="rbac" text="RBAC" >}}, +maka membaca metrik memerlukan otorisasi melalui _user_, _group_, atau +ServiceAccount dengan ClusterRole yang memperbolehkan untuk mengakses `/metrics`. + +Sebagai contoh: +```yaml +apiVersion: rbac.authorization.k8s.io/v1 +kind: ClusterRole +metadata: + name: prometheus +rules: + - nonResourceURLs: + - "/metrics" + verbs: + - get +``` + +## Siklus hidup metrik + +Metrik alfa (_alpha_) → Metrik stabil → Metrik usang (_deprecated_) → Metrik tersembunyi → Metrik terhapus + +Metrik alfa tidak memiliki jaminan stabilitas. Metrik ini +dapat dimodifikasi atau dihapus kapan saja. + +Metrik stabil dijamin tidak akan mengalami perubahan. Hal ini berarti: +* Metrik stabil tanpa penanda usang (_deprecated signature_) tidak akan dihapus ataupun diganti namanya +* Jenis metrik stabil tidak akan dimodifikasi + +Metrik usang dijadwalkan untuk dihapus, tetapi masih tersedia untuk digunakan. +Metrik ini mencakup anotasi versi di mana metrik ini dianggap menjadi usang. + +Sebagai contoh: + +* Sebelum menjadi usang + + ``` + # HELP some_counter this counts things + # TYPE some_counter counter + some_counter 0 + ``` + +* Setelah menjadi usang + + ``` + # HELP some_counter (Deprecated since 1.15.0) this counts things + # TYPE some_counter counter + some_counter 0 + ``` + +Metrik tersembunyi tidak lagi dipublikasikan untuk pengambilan metrik (_scraping_), tetapi masih tersedia untuk digunakan. Untuk menggunakan metrik tersembunyi, lihat bagian [Menampilkan metrik tersembunyi](#menampilkan-metrik-tersembunyi). + +Metrik yang terhapus tidak lagi dipublikasikan dan tidak dapat digunakan lagi. + +## Menampilkan metrik tersembunyi + +Seperti yang dijelaskan di atas, admin dapat mengaktifkan metrik tersembunyi melalui opsi baris perintah pada biner (program) tertentu. Ini dimaksudkan untuk digunakan sebagai jalan keluar bagi admin jika mereka melewatkan migrasi metrik usang dalam rilis terakhir. + +Opsi `show-hidden-metrics-for-version` menerima input versi yang kamu inginkan untuk menampilkan metrik usang dalam rilis tersebut. Versi tersebut dinyatakan sebagai x.y, di mana x adalah versi mayor, y adalah versi minor. Versi _patch_ tidak diperlukan meskipun metrik dapat menjadi usang dalam rilis _patch_, alasannya adalah kebijakan penandaan metrik usang dijalankan terhadap rilis minor. + +Opsi tersebut hanya dapat menerima input versi minor sebelumnya sebagai nilai. Semua metrik yang disembunyikan di versi sebelumnya akan dikeluarkan jika admin mengatur versi sebelumnya ke `show-hidden-metrics-for-version`. Versi yang terlalu lama tidak diperbolehkan karena melanggar kebijakan untuk metrik usang. + +Ambil metrik `A` sebagai contoh, di sini diasumsikan bahwa` A` sudah menjadi usang di versi 1.n. Berdasarkan kebijakan metrik usang, kita dapat mencapai kesimpulan berikut: + +* Pada rilis `1.n`, metrik menjadi usang, dan dapat dikeluarkan secara bawaan. +* Pada rilis `1.n+1`, metrik disembunyikan secara bawaan dan dapat dikeluarkan dengan baris perintah `show-hidden-metrics-for-version=1.n`. +* Pada rilis `1.n+2`, metrik harus dihapus dari _codebase_. Tidak ada jalan keluar lagi. + +Jika kamu meningkatkan versi dari rilis `1.12` ke `1.13`, tetapi masih bergantung pada metrik `A` yang usang di `1.12`, kamu harus mengatur metrik tersembunyi melalui baris perintah: `--show-hidden-metrics = 1.12` dan ingatlah untuk menghapus ketergantungan terhadap metrik ini sebelum meningkatkan versi rilis ke `1.14`. + +## Menonaktifkan metrik akselerator + +kubelet mengumpulkan metrik akselerator melalui cAdvisor. Untuk mengumpulkan metrik ini, untuk akselerator seperti GPU NVIDIA, kubelet membuka koneksi dengan _driver_ GPU. Ini berarti untuk melakukan perubahan infrastruktur (misalnya, pemutakhiran _driver_), administrator klaster perlu menghentikan agen kubelet. + +Pengumpulkan metrik akselerator sekarang menjadi tanggung jawab vendor dibandingkan kubelet. Vendor harus menyediakan sebuah kontainer untuk mengumpulkan metrik dan mengeksposnya ke layanan metrik (misalnya, Prometheus). + +[Gerbang fitur `DisableAcceleratorUsageMetrics`](/docs/reference/command-line-tools-reference/feature-gates/) menonaktifkan metrik yang dikumpulkan oleh kubelet, dengan [lini masa (_timeline_) untuk mengaktifkan fitur ini secara bawaan](https://github.com/kubernetes/enhancements/tree/411e51027db842355bd489691af897afc1a41a5e/keps/sig-node/1867-disable-accelerator-usage-metrics#graduation-criteria). + +## Metrik komponen + +### Metrik kube-controller-manager + +Metrik _controller manager_ memberikan gambaran penting +tentang kinerja dan kesehatan _controller manager_. Metrik ini mencakup metrik +_runtime_ bahasa Go yang umum seperti jumlah go_routine dan metrik khusus +pengontrol seperti latensi permintaan etcd atau latensi API Cloudprovider +(AWS, GCE, OpenStack) yang dapat digunakan untuk mengukur kesehatan klaster. + +Mulai dari Kubernetes 1.7, metrik Cloudprovider yang detail tersedia untuk +operasi penyimpanan untuk GCE, AWS, Vsphere, dan OpenStack. +Metrik ini dapat digunakan untuk memantau kesehatan operasi _persistent volume_. + +Misalnya, untuk GCE metrik-metrik berikut ini dipanggil: + +``` +cloudprovider_gce_api_request_duration_seconds { request = "instance_list"} +cloudprovider_gce_api_request_duration_seconds { request = "disk_insert"} +cloudprovider_gce_api_request_duration_seconds { request = "disk_delete"} +cloudprovider_gce_api_request_duration_seconds { request = "attach_disk"} +cloudprovider_gce_api_request_duration_seconds { request = "detach_disk"} +cloudprovider_gce_api_request_duration_seconds { request = "list_disk"} +``` + +### Metrik kube-scheduler + +{{< feature-state for_k8s_version="v1.20" state="alpha" >}} + +Penjadwal mengekspos metrik opsional yang melaporkan sumber daya yang diminta dan limit yang diinginkan dari semua pod yang berjalan. Metrik ini dapat digunakan untuk membangun dasbor perencanaan kapasitas, mengevaluasi limit penjadwalan yang digunakan saat ini atau secara historis, dengan cepat mengidentifikasi beban kerja yang tidak dapat dijadwalkan karena kurangnya sumber daya, dan membandingkan permintaan sumber daya oleh pod dengan penggunaannya yang aktual. + +kube-scheduler mengidentifikasi [permintaan dan limit](/docs/concepts/configuration/manage-resources-containers/) sumber daya yang dikonfigurasi untuk setiap Pod; jika permintaan atau limit bukan nol, kube-scheduler akan melaporkan deret waktu (_timeseries_) metrik. Deret waktu diberi label dengan: +- namespace +- nama pod +- node di mana pod dijadwalkan atau _string_ kosong jika belum dijadwalkan +- prioritas +- penjadwal yang ditugaskan untuk pod itu +- nama dari sumber daya (misalnya, `cpu`) +- satuan dari sumber daya jika diketahui (misalnya, `cores`) + +Setelah pod selesai (memiliki `restartPolicy` `Never` atau `OnFailure` dan berada dalam fase pod `Succeeded` atau `Failed`, atau telah dihapus dan semua kontainer dalam keadaan Terminated) deret metrik tidak lagi dilaporkan karena penjadwal sekarang sudah dibebaskan untuk menjadwalkan pod lain untuk dijalankan. Metrik yang dibahas pada bagian ini dikenal sebagai `kube_pod_resource_request` dan` kube_pod_resource_limit`. + +Metrik diekspos melalui _endpoint_ HTTP `/metrics/resources` dan memerlukan otorisasi yang sama seperti endpoint `/metrics` +pada penjadwal. Kamu harus menggunakan opsi `--show-hidden-metrics-for-version=1.20` untuk mengekspos metrik-metrik stabilitas alfa ini. + +## {{% heading "whatsnext" %}} + +* Baca tentang [format teks Prometheus](https://github.com/prometheus/docs/blob/master/content/docs/instrumenting/exposition_formats.md#text-based-format) untuk berbagai metrik +* Baca tentang [kebijakan _deprecation_ Kubernetes](/docs/reference/using-api/deprecation-policy/#deprecating-a-feature-or-behavior) From 10be302dcee60cb522ee0fd9288231241b462b43 Mon Sep 17 00:00:00 2001 From: Alec Rajeev Date: Thu, 25 Mar 2021 21:03:53 -0400 Subject: [PATCH 027/104] Fix link for Horizontal Pod Autoscaler enhancement --- .../en/docs/tasks/run-application/horizontal-pod-autoscale.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/tasks/run-application/horizontal-pod-autoscale.md b/content/en/docs/tasks/run-application/horizontal-pod-autoscale.md index 763d9ab996..b2643ff282 100644 --- a/content/en/docs/tasks/run-application/horizontal-pod-autoscale.md +++ b/content/en/docs/tasks/run-application/horizontal-pod-autoscale.md @@ -356,7 +356,7 @@ and [the walkthrough for using external metrics](/docs/tasks/run-application/hor ## Support for configurable scaling behavior Starting from -[v1.18](https://github.com/kubernetes/enhancements/blob/master/keps/sig-autoscaling/20190307-configurable-scale-velocity-for-hpa.md) +[v1.18](https://github.com/kubernetes/enhancements/blob/master/keps/sig-autoscaling/853-configurable-hpa-scale-velocity/README.md) the `v2beta2` API allows scaling behavior to be configured through the HPA `behavior` field. Behaviors are specified separately for scaling up and down in `scaleUp` or `scaleDown` section under the `behavior` field. A stabilization From 487bd4fa46b8a47722156d002d0a2a5bb81e57ed Mon Sep 17 00:00:00 2001 From: Qiming Teng Date: Thu, 25 Mar 2021 19:59:42 +0800 Subject: [PATCH 028/104] [zh] Resync security overview --- content/zh/docs/concepts/security/overview.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/content/zh/docs/concepts/security/overview.md b/content/zh/docs/concepts/security/overview.md index 19ce78672f..68ef8ba63d 100644 --- a/content/zh/docs/concepts/security/overview.md +++ b/content/zh/docs/concepts/security/overview.md @@ -164,7 +164,7 @@ areas of security concerns and recommendations for securing workloads running in Area of Concern for Workload Security | Recommendation | ------------------------------ | --------------------- | RBAC Authorization (Access to the Kubernetes API) | https://kubernetes.io/docs/reference/access-authn-authz/rbac/ -Authentication | https://kubernetes.io/docs/reference/access-authn-authz/controlling-access/ +Authentication | https://kubernetes.io/docs/concepts/security/controlling-access/ Application secrets management (and encrypting them in etcd at rest) | https://kubernetes.io/docs/concepts/configuration/secret/
https://kubernetes.io/docs/tasks/administer-cluster/encrypt-data/ Pod Security Policies | https://kubernetes.io/docs/concepts/policy/pod-security-policy/ Quality of Service (and Cluster resource management) | https://kubernetes.io/docs/tasks/configure-pod-container/quality-service-pod/ @@ -178,10 +178,10 @@ TLS For Kubernetes Ingress | https://kubernetes.io/docs/concepts/services-networ 容易受到资源枯竭的攻击,则如果你不限制服务 B 的资源的话,损害服务 A 的风险就会很高。 下表列出了安全性关注的领域和建议,用以保护 Kubernetes 中运行的工作负载: -工作负载安全性关注领域 | 建议 | +工作负载安全性关注领域 | 建议 | ------------------------------ | --------------------- | RBAC 授权(访问 Kubernetes API) | https://kubernetes.io/zh/docs/reference/access-authn-authz/rbac/ -认证方式 | https://kubernetes.io/zh/docs/reference/access-authn-authz/controlling-access/ +认证方式 | https://kubernetes.io/zh/docs/concepts/security/controlling-access/ 应用程序 Secret 管理 (并在 etcd 中对其进行静态数据加密) | https://kubernetes.io/zh/docs/concepts/configuration/secret/
https://kubernetes.io/zh/docs/tasks/administer-cluster/encrypt-data/ Pod 安全策略 | https://kubernetes.io/zh/docs/concepts/policy/pod-security-policy/ 服务质量(和集群资源管理)| https://kubernetes.io/zh/docs/tasks/configure-pod-container/quality-service-pod/ @@ -199,6 +199,7 @@ Area of Concern for Containers | Recommendation | Container Vulnerability Scanning and OS Dependency Security | As part of an image build step, you should scan your containers for known vulnerabilities. Image Signing and Enforcement | Sign container images to maintain a system of trust for the content of your containers. Disallow privileged users | When constructing containers, consult your documentation for how to create users inside of the containers that have the least level of operating system privilege necessary in order to carry out the goal of the container. +Use container runtime with stronger isolation | Select [container runtime classes](/docs/concepts/containers/runtime-class/) that provider stronger isolation --> ## 容器 @@ -209,7 +210,7 @@ Disallow privileged users | When constructing containers, consult your documenta 容器漏洞扫描和操作系统依赖安全性 | 作为镜像构建的一部分,您应该扫描您的容器里的已知漏洞。 镜像签名和执行 | 对容器镜像进行签名,以维护对容器内容的信任。 禁止特权用户 | 构建容器时,请查阅文档以了解如何在具有最低操作系统特权级别的容器内部创建用户,以实现容器的目标。 - +使用带有较强隔离能力的容器运行时 | 选择提供较强隔离能力的[容器运行时类](/zh/docs/concepts/containers/runtime-class/)。 学习了解相关的 Kubernetes 安全主题: @@ -272,4 +274,5 @@ Learn about related Kubernetes security topics: * 为控制面[加密通信中的数据](/zh/docs/tasks/tls/managing-tls-in-a-cluster/) * [加密静止状态的数据](/zh/docs/tasks/administer-cluster/encrypt-data/) * [Kubernetes 中的 Secret](/zh/docs/concepts/configuration/secret/) +* [运行时类](/zh/docs/concepts/containers/runtime-class) From e6aa137ac242f751f59796ac2e29da2075ed9003 Mon Sep 17 00:00:00 2001 From: konglinghang Date: Fri, 26 Mar 2021 14:35:21 +0800 Subject: [PATCH 029/104] fix a word translation --- content/zh/docs/concepts/workloads/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/zh/docs/concepts/workloads/_index.md b/content/zh/docs/concepts/workloads/_index.md index 743d452d99..7130758cd3 100644 --- a/content/zh/docs/concepts/workloads/_index.md +++ b/content/zh/docs/concepts/workloads/_index.md @@ -38,7 +38,7 @@ all the pods on that node fail. Kubernetes treats that level of failure as final would need to create a new `Pod` to recover, even if the node later becomes healthy. --> Kubernetes Pods 有[确定的生命周期](/zh/docs/concepts/workloads/pods/pod-lifecycle/)。 -例如,一旦某 Pod 在你的集群中运行,Pod 运行所在的 +例如,当某 Pod 在你的集群中运行,Pod 运行所在的 {{< glossary_tooltip text="节点" term_id="node" >}} 出现致命错误时, 所有该节点上的 Pods 都会失败。Kubernetes 将这类失败视为最终状态: 即使该节点后来恢复正常运行,你也需要创建新的 Pod 来恢复应用。 From e9783b0cb459cbfc9edee0f61fdd49f220ceeba7 Mon Sep 17 00:00:00 2001 From: carol valencia Date: Fri, 26 Mar 2021 11:59:28 -0300 Subject: [PATCH 030/104] feat: content/es/docs/concepts/security/overview --- content/es/docs/concepts/security/_index.md | 5 + content/es/docs/concepts/security/overview.md | 152 ++++++++++++++++++ 2 files changed, 157 insertions(+) create mode 100644 content/es/docs/concepts/security/_index.md create mode 100644 content/es/docs/concepts/security/overview.md diff --git a/content/es/docs/concepts/security/_index.md b/content/es/docs/concepts/security/_index.md new file mode 100644 index 0000000000..cdc487195d --- /dev/null +++ b/content/es/docs/concepts/security/_index.md @@ -0,0 +1,5 @@ +--- +title: "Seguridad" +weight: 81 +--- + diff --git a/content/es/docs/concepts/security/overview.md b/content/es/docs/concepts/security/overview.md new file mode 100644 index 0000000000..c045b32614 --- /dev/null +++ b/content/es/docs/concepts/security/overview.md @@ -0,0 +1,152 @@ +--- +title: Vista General da Seguridad Cloud Native +content_type: concept +weight: 10 +--- + + + +Esta descripción general define un modelo para la seguridad de Kubernetes en el contexto da Seguridad en Cloud Native. + +{{< warning >}} +Este modelo de seguridad en el contenedor brinda sugerencias, no es una prueba de políticas de seguridad de la información. +{{< /warning >}} + + + +## Las 4C de Seguridad en Cloud Native + +Puede pensar en seguridad por capas. Las 4C de la seguridad nativa de la nube son la nube(Cloud), +Clústeres, contenedores y código. + +{{< note >}} +Este enfoque en capas aumenta la [defensa en profundidad](https://en.wikipedia.org/wiki/Defense_in_depth_(computing)) +de la seguridad, es considerada una buena práctica en seguridad para el software de sistemas. +{{< /note >}} + +{{< figure src="/images/docs/4c.png" title="Las 4C de Seguridad en Cloud Native" >}} + +Cada capa del modelo de seguridad Cloud Native es basada en la siguiente capa más externa. +La capa de código se beneficia de una base sólida(nube, clúster, contenedor) de capas seguras. +No podemos garantir seguridad aplicando solo seguridad a nivel del Código, y usar estándares de seguridad deficientes en las otras capas. + +## Cloud + +En muchos sentidos, la nube (o los servidores o el centro de datos corporativo) es la +[base informática confiable](https://en.wikipedia.org/wiki/Trusted_computing_base) +de un clúster de Kubernetes. Si la capa de la nube es vulnerable (o +configurado de alguna manera vulnerable), por consecuencia no hay garantía de que los componentes construidos +encima de la base sean seguras. Cada proveedor de la nube tiene recomendaciones de seguridad +para ejecutar las cargas de trabajo de forma segura en sus entornos. + +### Seguridad del proveedor de la nube + +Si está ejecutando un clúster de Kubernetes en su propio hardware o en un proveedor de nube diferente, +consulte la documentación para conocer las mejores prácticas de seguridad. +A continuación, algunos enlaces a la documentación de seguridad de los proveedores de nube más populares: + +{{< table caption="Cloud provider security" >}} + +Provedor IaaS | Link | +-------------------- | ------------ | +Alibaba Cloud | https://www.alibabacloud.com/trust-center | +Amazon Web Services | https://aws.amazon.com/security/ | +Google Cloud Platform | https://cloud.google.com/security/ | +IBM Cloud | https://www.ibm.com/cloud/security | +Microsoft Azure | https://docs.microsoft.com/en-us/azure/security/azure-security | +VMWare VSphere | https://www.vmware.com/security/hardening-guides.html | + +{{< /table >}} + +### Seguridad de la Infraestructura {#infrastructure-security} + +Sugerencias para proteger su infraestructura en un clúster de Kubernetes: + +{{< table caption="Infrastructure security" >}} + +Área de Interés para la Infraestructura de Kubernetes | Recomendación | +--------------------------------------------- | -------------- | +Acceso de red al servidor API (Plano de Control) | Todo acceso público al plano de control del Kubernetes en la Internet no está permitido y es controlado por listas de control de acceso a la red restrictas a un conjunto de direcciones IP necesarios para administrar el clúster.| +Acceso a la red de los Nodos | Los nodos deben ser configurados para _sólo_ aceptar conexiones (por medio de listas de control de acceso a la red) desde el plano de control en los puertos especificados y aceptar conexiones para servicios en Kubernetes del tipo NodePort y LoadBalancer. Si es posible, estos nodos no deben exponerse públicamente en la Internet. +Acceso de la API del Kubernetes al proveedor de la Cloud | Cada proveedor de la nube debe dar un conjunto de permisos al plano de control y nodos del Kubernetes. Es mejor otorgar al clúster el permiso de acceso al proveedor de nube siguiendo el [principio del mínimo privilegio](https://en.wikipedia.org/wiki/Principle_of_least_privilege) para los recursos que necesite administrar. La [documentación del Kops](https://github.com/kubernetes/kops/blob/master/docs/iam_roles.md#iam-roles) fornece informações sobre as políticas e roles do IAM. +Acceso al etcd | El acceso al etcd (banco de dados do Kubernetes) debe ser limitado apenas al plano de control. Dependiendo de su configuración, debería intentar usar etcd sobre TLS. Mayores informaciones pueden ser encontradas en la [documentación del etcd](https://github.com/etcd-io/etcd/tree/master/Documentation). +Encriptación etcd | Siempre que sea posible, es una buena práctica encriptar todas las unidades de almacenamiento, el etcd mantiene el estado de todo el clúster (incluidos los Secretos), su disco debe estar encriptado. + +{{< /table >}} + +## Cluster + +Existe dos áreas de preocupación para proteger o Kubernetes: + +* Protección de las configuraciones de los componentes del clúster. +* Protección de las aplicaciones que se ejecutan en el clúster. + +### Componentes del Clúster {#cluster-components} + +Si desea proteger su clúster de accesos accidentales o maliciosos y adoptar +buenas prácticas de seguridad, a continuación los consejos sobre +[protegiendo el cluster](/docs/tasks/administer-cluster/securing-a-cluster/). + +### Componentes del clúster (su aplicación) {#cluster-applications} + +Dependiendo de la superficie de ataque de su aplicación, es posible que desee concentrarse en +temas de seguridad específicos. Por ejemplo: si está ejecutando un servicio (Servicio A) que es crítico +en una cadena de otros recursos y otra carga de trabajo separada (Servicio B) que es +vulnerable a un ataque de sobrecarga de recursos y, en consecuencia, el riesgo de comprometer el Servicio A +es alto si no limita las funciones del Servicio B. La siguiente tabla enumera +áreas de atención de seguridad y recomendaciones para proteger las cargas de trabajo que se ejecutan en Kubernetes: + +Áreas para la seguridad de la carga del trabajo | Recomendación | +------------------------------ | --------------------- | +Autorización RBAC (acceso a la API Kubernetes) | https://kubernetes.io/docs/reference/access-authn-authz/rbac/ +Autenticación | https://kubernetes.io/docs/concepts/security/controlling-access/ +Administrar secretos en la aplicación (encriptar el etcd - dato en reposo) | https://kubernetes.io/docs/concepts/configuration/secret/
https://kubernetes.io/docs/tasks/administer-cluster/encrypt-data/ +Políticas de seguridad de Pod | https://kubernetes.io/docs/concepts/policy/pod-security-policy/ +Calidad de servicio (y gestión de recursos del clúster) | https://kubernetes.io/docs/tasks/configure-pod-container/quality-service-pod/ +Políticas de Red | https://kubernetes.io/docs/concepts/services-networking/network-policies/ +TLS para Kubernetes Ingress | https://kubernetes.io/docs/concepts/services-networking/ingress/#tls + +## Contenedor + +La seguridad de los contenedores está fuera del alcance de la guía. Aquí hay recomendaciones generales y +enlaces para explorar este tema: + +Área de Interés para Contenedores | Recomendación | +------------------------------ | -------------- | +Escáneres de vulnerabilidad de contenedores y seguridad de dependencia del sistema operativo | Como parte del paso de la creación de la imagen, se debe utilizar un escáner de contenedores para detectar vulnerabilidades. +Firma de Imágenes y Aplicación | Firma de imágenes de contenedores para mantener un sistema confiable para el contenido de sus contenedores. +Prohibir Usuarios Privilegiados | Al crear contenedores, consulte la documentación para crear usuarios dentro de los contenedores con el menor privilegio necesario para cumplir con el propósito del contenedor en el sistema operativo. +Utilice el contenedor de tiempo de ejecución con el aislamiento más fuerte | Seleccione [clases del contenedor runtime](/docs/concepts/containers/runtime-class/) con el proveedor de aislamiento más fuerte. + +## Código + +El código de la aplicación es una de las principales superficies de ataque sobre las que tenemos más control. +Aunque la protección del código de la aplicación está fuera del tema de seguridad de Kubernetes, aquí algunas +recomendaciones para proteger el código de su aplicación: + +### Seguridad del código + +{{< table caption="Code security" >}} + +Áreas de Atención para el Código | Recomendación | +-------------------------| -------------- | +Acceso solo a través de TLS | Si su código necesita comunicarse a través de TCP, ejecute un handshake TLS con el cliente anticipadamente. Con la excepción de algunos casos, encripte todo lo que está en tránsito. Yendo un paso más allá, es una buena idea cifrar el tráfico de red entre los servicios. Esto se puede hacer a través del proceso de autenticación mutua o [mTLS](https://en.wikipedia.org/wiki/Mutual_authentication), que realiza una verificación bilateral de la comunicación a través de los certificados en los servicios. | +Limitación de intervalos de puertos de comunicación | Esta recomendación puede ser un poco evidente, pero siempre que sea posible, solo debe exponer los puertos de su servicio que son absolutamente esenciales para la comunicación o la recopilación de métricas. | +Seguridad en dependencia de terceros | Es una buena práctica comprobar periódicamente las bibliotecas de terceros de su aplicación en busca de vulnerabilidades de seguridad. Cada lenguaje de programación tiene una herramienta para realizar esta verificación de forma automática. | +Análisis de código estático | La mayoría de los lenguajes proporcionan una forma de analizar el código en busca de prácticas de codificación potencialmente inseguras. Siempre que sea posible, debe automatizar los escaneos utilizando herramientas que puedan escanear las bases del código en busca de errores de seguridad comunes. Algunas de las herramientas se pueden encontrar en [OWASP Source Code Analysis Tools](https://owasp.org/www-community/Source_Code_Analysis_Tools). | +Ataques de sondeo dinámica | Existen algunas herramientas automatizadas que puede ejecutar en su servicio para explorar algunos de los ataques más conocidos. Esto incluye la inyección de SQL, CSRF y XSS. Una de las herramientas de análisis dinámico más populares es la [OWASP Zed Attack proxy](https://owasp.org/www-project-zap/). | + +{{< /table >}} + +## {{% heading "whatsnext" %}} + +Obtenga más información sobre los temas de seguridad de Kubernetes: + +* [Estándares de seguridad del pod](/docs/concepts/security/pod-security-standards/) +* [Políticas de red para pods](/docs/concepts/services-networking/network-policies/) +* [Control de acceso a la API de Kubernetes](/docs/concepts/security/controlling-access) +* [Protegiendo su cluster](/docs/tasks/administer-cluster/securing-a-cluster/) +* [Criptografía de datos en tránsito](/docs/tasks/tls/managing-tls-in-a-cluster/) for the control plane +* [Criptografía de datos en reposo](/docs/tasks/administer-cluster/encrypt-data/) +* [Secretos en Kubernetes](/docs/concepts/configuration/secret/) +* [Runtime class](/docs/concepts/containers/runtime-class) \ No newline at end of file From 2df104f9396581e70d7d99c24aaea737194ff26b Mon Sep 17 00:00:00 2001 From: carol valencia Date: Fri, 26 Mar 2021 15:46:18 -0300 Subject: [PATCH 031/104] chore: content/es/docs/concepts/security/overview --- content/es/docs/concepts/security/overview.md | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/content/es/docs/concepts/security/overview.md b/content/es/docs/concepts/security/overview.md index c045b32614..fdb3828cfe 100644 --- a/content/es/docs/concepts/security/overview.md +++ b/content/es/docs/concepts/security/overview.md @@ -1,12 +1,12 @@ --- -title: Vista General da Seguridad Cloud Native +title: Vista General de Seguridad Cloud Native content_type: concept weight: 10 --- -Esta descripción general define un modelo para la seguridad de Kubernetes en el contexto da Seguridad en Cloud Native. +Esta descripción general define un modelo para la seguridad de Kubernetes en el contexto de Seguridad en Cloud Native. {{< warning >}} Este modelo de seguridad en el contenedor brinda sugerencias, no es una prueba de políticas de seguridad de la información. @@ -16,8 +16,8 @@ Este modelo de seguridad en el contenedor brinda sugerencias, no es una prueba d ## Las 4C de Seguridad en Cloud Native -Puede pensar en seguridad por capas. Las 4C de la seguridad nativa de la nube son la nube(Cloud), -Clústeres, contenedores y código. +Puede pensar en seguridad por capas. Las 4C de la seguridad en cloud Native son la nube(Cloud), +Clústeres, Contenedores y Código. {{< note >}} Este enfoque en capas aumenta la [defensa en profundidad](https://en.wikipedia.org/wiki/Defense_in_depth_(computing)) @@ -28,7 +28,7 @@ de la seguridad, es considerada una buena práctica en seguridad para el softwar Cada capa del modelo de seguridad Cloud Native es basada en la siguiente capa más externa. La capa de código se beneficia de una base sólida(nube, clúster, contenedor) de capas seguras. -No podemos garantir seguridad aplicando solo seguridad a nivel del Código, y usar estándares de seguridad deficientes en las otras capas. +No podemos garantizar la seguridad aplicando solo seguridad a nivel del código, y usar estándares de seguridad deficientes en las otras capas. ## Cloud @@ -76,7 +76,7 @@ Encriptación etcd | Siempre que sea posible, es una buena práctica encriptar t ## Cluster -Existe dos áreas de preocupación para proteger o Kubernetes: +Existe dos áreas de preocupación para proteger Kubernetes: * Protección de las configuraciones de los componentes del clúster. * Protección de las aplicaciones que se ejecutan en el clúster. @@ -84,8 +84,8 @@ Existe dos áreas de preocupación para proteger o Kubernetes: ### Componentes del Clúster {#cluster-components} Si desea proteger su clúster de accesos accidentales o maliciosos y adoptar -buenas prácticas de seguridad, a continuación los consejos sobre -[protegiendo el cluster](/docs/tasks/administer-cluster/securing-a-cluster/). +buenas prácticas de seguridad, a continuación sigue estos consejos sobre +[como proteger el clúster](/docs/tasks/administer-cluster/securing-a-cluster/). ### Componentes del clúster (su aplicación) {#cluster-applications} @@ -134,7 +134,7 @@ Acceso solo a través de TLS | Si su código necesita comunicarse a través de T Limitación de intervalos de puertos de comunicación | Esta recomendación puede ser un poco evidente, pero siempre que sea posible, solo debe exponer los puertos de su servicio que son absolutamente esenciales para la comunicación o la recopilación de métricas. | Seguridad en dependencia de terceros | Es una buena práctica comprobar periódicamente las bibliotecas de terceros de su aplicación en busca de vulnerabilidades de seguridad. Cada lenguaje de programación tiene una herramienta para realizar esta verificación de forma automática. | Análisis de código estático | La mayoría de los lenguajes proporcionan una forma de analizar el código en busca de prácticas de codificación potencialmente inseguras. Siempre que sea posible, debe automatizar los escaneos utilizando herramientas que puedan escanear las bases del código en busca de errores de seguridad comunes. Algunas de las herramientas se pueden encontrar en [OWASP Source Code Analysis Tools](https://owasp.org/www-community/Source_Code_Analysis_Tools). | -Ataques de sondeo dinámica | Existen algunas herramientas automatizadas que puede ejecutar en su servicio para explorar algunos de los ataques más conocidos. Esto incluye la inyección de SQL, CSRF y XSS. Una de las herramientas de análisis dinámico más populares es la [OWASP Zed Attack proxy](https://owasp.org/www-project-zap/). | +Ataques de sondeo dinámico | Existen algunas herramientas automatizadas que puede ejecutar en su servicio para explorar algunos de los ataques más conocidos. Esto incluye la inyección de SQL, CSRF y XSS. Una de las herramientas de análisis dinámico más populares es la [OWASP Zed Attack proxy](https://owasp.org/www-project-zap/). | {{< /table >}} @@ -145,7 +145,7 @@ Obtenga más información sobre los temas de seguridad de Kubernetes: * [Estándares de seguridad del pod](/docs/concepts/security/pod-security-standards/) * [Políticas de red para pods](/docs/concepts/services-networking/network-policies/) * [Control de acceso a la API de Kubernetes](/docs/concepts/security/controlling-access) -* [Protegiendo su cluster](/docs/tasks/administer-cluster/securing-a-cluster/) +* [Protegiendo su clúster](/docs/tasks/administer-cluster/securing-a-cluster/) * [Criptografía de datos en tránsito](/docs/tasks/tls/managing-tls-in-a-cluster/) for the control plane * [Criptografía de datos en reposo](/docs/tasks/administer-cluster/encrypt-data/) * [Secretos en Kubernetes](/docs/concepts/configuration/secret/) From a6333facb457351406f5f77ab74752a47bf3415c Mon Sep 17 00:00:00 2001 From: Neto Deolino Date: Fri, 26 Mar 2021 18:04:37 -0300 Subject: [PATCH 032/104] renamed incorrect word in Portuguese --- .../tutorials/kubernetes-basics/deploy-app/deploy-intro.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/pt/docs/tutorials/kubernetes-basics/deploy-app/deploy-intro.html b/content/pt/docs/tutorials/kubernetes-basics/deploy-app/deploy-intro.html index a5bdb75e8d..1d927cf038 100644 --- a/content/pt/docs/tutorials/kubernetes-basics/deploy-app/deploy-intro.html +++ b/content/pt/docs/tutorials/kubernetes-basics/deploy-app/deploy-intro.html @@ -31,7 +31,7 @@ weight: 10 Assim que o seu cluster Kubernetes estiver em execução você pode implementar seu aplicativo em contêiners nele. Para fazer isso, você precisa criar uma configuração do tipo Deployment do Kubernetes. O Deployment define como criar e atualizar instâncias do seu aplicativo. Depois de criar um Deployment, o Master do Kubernetes - agenda as instâncias do aplicativo incluídas nesse Deployment para ser executado em nós individuais do CLuster. + agenda as instâncias do aplicativo incluídas nesse Deployment para ser executado em nós individuais do Cluster.

Depois que as instâncias do aplicativo são criadas, um Controlador do Kubernetes Deployment monitora continuamente essas instâncias. From fa5ef755a2439c1e3665a617387e6e2b88baedf4 Mon Sep 17 00:00:00 2001 From: Bharath Vedartham Date: Sat, 27 Mar 2021 13:52:54 +0530 Subject: [PATCH 033/104] Explicitly specify kubernetes system daemons --- .../docs/tasks/administer-cluster/reserve-compute-resources.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/tasks/administer-cluster/reserve-compute-resources.md b/content/en/docs/tasks/administer-cluster/reserve-compute-resources.md index b6249f50ef..a5661263f2 100644 --- a/content/en/docs/tasks/administer-cluster/reserve-compute-resources.md +++ b/content/en/docs/tasks/administer-cluster/reserve-compute-resources.md @@ -90,7 +90,7 @@ In addition to `cpu`, `memory`, and `ephemeral-storage`, `pid` may be specified to reserve the specified number of process IDs for kubernetes system daemons. -To optionally enforce `kube-reserved` on system daemons, specify the parent +To optionally enforce `kube-reserved` on kubernetes system daemons, specify the parent control group for kube daemons as the value for `--kube-reserved-cgroup` kubelet flag. From 2c530c295aab7f94b0ba2c16572957b8219e3345 Mon Sep 17 00:00:00 2001 From: Henry Liu Date: Sat, 27 Mar 2021 16:50:43 +0800 Subject: [PATCH 034/104] Improve "look and feel" of tabs to make it clearer where they start/end (#26828) * improve "look and feel" of tabs to make it clearer where they start/end * add border-radius to tab-pane * remove the .td-content .hightlight margin when inside the tab-content --- assets/scss/_base.scss | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/assets/scss/_base.scss b/assets/scss/_base.scss index b1b112cb38..4113b49bee 100644 --- a/assets/scss/_base.scss +++ b/assets/scss/_base.scss @@ -869,3 +869,22 @@ body.td-documentation { display: none; } } + +// nav-tabs and tab-content +.nav-tabs { + border-bottom: none !important; +} + +.td-content .tab-content .highlight { + margin: 0; +} + +.tab-pane { + border-radius: 0.25rem; + padding: 0 16px 16px; + + border: 1px solid #dee2e6; + &:first-of-type.active { + border-top-left-radius: 0; + } +} From c2ab7156ef70041151b49cfb7a79031ee57b34f1 Mon Sep 17 00:00:00 2001 From: Stefan Scheidewig <59603579+stefan-scheidewig@users.noreply.github.com> Date: Sat, 27 Mar 2021 10:15:54 +0100 Subject: [PATCH 035/104] Fixed typo in german setup documentation --- content/de/docs/setup/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/de/docs/setup/_index.md b/content/de/docs/setup/_index.md index d7f074efb3..2203fcc19c 100644 --- a/content/de/docs/setup/_index.md +++ b/content/de/docs/setup/_index.md @@ -9,7 +9,7 @@ content_type: concept Diese Sektion umfasst verschiedene Optionen zum Einrichten und Betrieb von Kubernetes. -Verschiedene Kubernetes Lösungen haben verschiedene Anforderungen: Einfache Wartung, Sicherheit, Kontrolle, verfügbare Resourcen und erforderliches Fachwissen zum Betrieb und zur Verwaltung dess folgende Diagramm zeigt die möglichen Abstraktionen eines Kubernetes-Clusters und ob eine Abstraktion selbst verwaltet oder von einem Anbieter verwaltet wird. +Verschiedene Kubernetes Lösungen haben verschiedene Anforderungen: Einfache Wartung, Sicherheit, Kontrolle, verfügbare Resourcen und erforderliches Fachwissen zum Betrieb und zur Verwaltung. Das folgende Diagramm zeigt die möglichen Abstraktionen eines Kubernetes-Clusters und ob eine Abstraktion selbst verwaltet oder von einem Anbieter verwaltet wird. Sie können einen Kubernetes-Cluster auf einer lokalen Maschine, Cloud, On-Prem Datacenter bereitstellen; oder wählen Sie einen verwalteten Kubernetes-Cluster. Sie können auch eine individuelle Lösung über eine grosse Auswahl an Cloud Anbietern oder Bare-Metal-Umgebungen nutzen. From da8012d6844f86e48477ba14bb4d312f2876e19c Mon Sep 17 00:00:00 2001 From: ydFu Date: Sat, 27 Mar 2021 21:33:28 +0800 Subject: [PATCH 036/104] [zh] Sync tasks pages for reserve-compute-resources.md * Sync with english version in 'Explicitly specify kubernetes system daemons in doc(#27249)' Signed-off-by: ydFu --- .../tasks/administer-cluster/reserve-compute-resources.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/content/zh/docs/tasks/administer-cluster/reserve-compute-resources.md b/content/zh/docs/tasks/administer-cluster/reserve-compute-resources.md index 381697d352..f03e2bde30 100644 --- a/content/zh/docs/tasks/administer-cluster/reserve-compute-resources.md +++ b/content/zh/docs/tasks/administer-cluster/reserve-compute-resources.md @@ -160,20 +160,21 @@ kubernetes 系统守护进程记述其资源预留值。 kubernetes 系统守护进程预留指定数量的进程 ID。 -要选择性地对系统守护进程上执行 `kube-reserved` 保护,需要把 kubelet 的 +要选择性地对 kubernetes 系统守护进程上执行 `kube-reserved` 保护,需要把 kubelet 的 `--kube-reserved-cgroup` 标志的值设置为 kube 守护进程的父控制组。 推荐将 kubernetes 系统守护进程放置于顶级控制组之下(例如 systemd 机器上的 From 72b37b1c6a678604d07f8e914555f87503692715 Mon Sep 17 00:00:00 2001 From: "Edson C. (aka tuxpilgrim)" Date: Sat, 27 Mar 2021 17:42:43 -0300 Subject: [PATCH 037/104] Update content/pt/docs/concepts/cluster-administration/_index.md (#27255) * Update content/pt/docs/concepts/cluster-administration/_index.md * Update title * Fix typo MOnitoramento --- .../concepts/cluster-administration/_index.md | 66 ++++++++++++++++++- 1 file changed, 65 insertions(+), 1 deletion(-) diff --git a/content/pt/docs/concepts/cluster-administration/_index.md b/content/pt/docs/concepts/cluster-administration/_index.md index 75c4425176..67051766ed 100755 --- a/content/pt/docs/concepts/cluster-administration/_index.md +++ b/content/pt/docs/concepts/cluster-administration/_index.md @@ -1,5 +1,69 @@ --- -title: "Administração de Cluster" +title: Administração de Cluster weight: 100 +content_type: concept +description: > + Detalhes de baixo nível relevantes para criar ou administrar um cluster Kubernetes. +no_list: true --- + +A visão geral da administração do cluster é para qualquer pessoa que crie ou administre um cluster do Kubernetes. +É pressuposto alguma familiaridade com os [conceitos](/docs/concepts) principais do Kubernetes. + + +## Planejando um cluster + +Consulte os guias em [Configuração](/docs/setup) para exemplos de como planejar, instalar e configurar clusters Kubernetes. As soluções listadas neste artigo são chamadas de *distros*. + + {{< note >}} + Nem todas as distros são mantidas ativamente. Escolha distros que foram testadas com uma versão recente do Kubernetes. + {{< /note >}} + +Antes de escolher um guia, aqui estão algumas considerações: + +- Você quer experimentar o Kubernetes em seu computador ou deseja criar um cluster de vários nós com alta disponibilidade? Escolha as distros mais adequadas ás suas necessidades. +- Você vai usar um **cluster Kubernetes gerenciado** , como o [Google Kubernetes Engine](https://cloud.google.com/kubernetes-engine/), ou **vai hospedar seu próprio cluster**? +- Seu cluster será **local**, ou **na nuvem (IaaS)**? O Kubernetes não oferece suporte direto a clusters híbridos. Em vez disso, você pode configurar vários clusters. +- **Se você estiver configurando o Kubernetes local**, leve em consideração qual [modelo de rede](/docs/concepts/cluster-Administration/networking) se encaixa melhor. +- Você vai executar o Kubernetes em um hardware **bare metal** ou em **máquinas virtuais? (VMs)**? +- Você **deseja apenas executar um cluster** ou espera **participar ativamente do desenvolvimento do código do projeto Kubernetes**? Se for a segunda opção, +escolha uma distro desenvolvida ativamente. Algumas distros usam apenas versão binária, mas oferecem uma maior variedade de opções. +- Familiarize-se com os [componentes](/docs/concepts/overview/components/) necessários para executar um cluster. + + +## Gerenciando um cluster + +* Aprenda como [gerenciar nós](/docs/concepts/architecture/nodes/). +* Aprenda a configurar e [gerenciar a quota de recursos](/docs/concepts/policy/resource-quotas/) para clusters compartilhados. + +## Protegendo um cluster + +* [Gerar Certificados](/docs/tasks/administer-cluster/certificates/) descreve os passos para gerar certificados usando diferentes cadeias de ferramentas. + +* [Ambiente de Contêineres do Kubernetes](/docs/concepts/containers/container-environment/) descreve o ambiente para contêineres gerenciados pelo kubelet em um nó Kubernetes. + +* [Controle de Acesso a API do Kubernetes](/docs/concepts/security/controlling-access) descreve como o Kubernetes implementa o controle de acesso para sua própria API. + +* [Autenticação](/docs/reference/access-authn-authz/authentication/) explica a autenticação no Kubernetes, incluindo as várias opções de autenticação. + +* [Autorização](/docs/reference/access-authn-authz/authorization/) é separado da autenticação e controla como as chamadas HTTP são tratadas. + +* [Usando Controladores de Admissão](/docs/reference/access-authn-authz/admission-controllers/) explica plugins que interceptam requisições para o servidor da API Kubernetes após +a autenticação e autorização. + +* [usando Sysctl em um Cluster Kubernetes](/docs/tasks/administer-cluster/sysctl-cluster/) descreve a um administrador como usar a ferramenta de linha de comando `sysctl` para +definir os parâmetros do kernel. + +* [Auditoria](/docs/tasks/debug-application-cluster/audit/) descreve como interagir com *logs* de auditoria do Kubernetes. + +### Protegendo o kubelet + * [Comunicação Control Plane-Nó](/docs/concepts/architecture/control-plane-node-communication/) + * [TLS bootstrapping](/docs/reference/command-line-tools-reference/kubelet-tls-bootstrapping/) + * [Autenticação/autorização do kubelet](/docs/reference/command-line-tools-reference/kubelet-authentication-authorization/) + +## Serviços Opcionais para o Cluster + +* [Integração com DNS](/docs/concepts/services-networking/dns-pod-service/) descreve como resolver um nome DNS diretamente para um serviço Kubernetes. + +* [Registro e Monitoramento da Atividade do Cluster](/docs/concepts/cluster-administration/logging/) explica como funciona o *logging* no Kubernetes e como implementá-lo. From 229a65e46f5fa83d099dcb6ee1554c39fb01ff66 Mon Sep 17 00:00:00 2001 From: Arhell Date: Sun, 28 Mar 2021 01:38:43 +0200 Subject: [PATCH 038/104] [id] remove command from output block --- .../run-application/run-stateless-application-deployment.md | 1 - 1 file changed, 1 deletion(-) diff --git a/content/id/docs/tasks/run-application/run-stateless-application-deployment.md b/content/id/docs/tasks/run-application/run-stateless-application-deployment.md index a069188de6..74e76c827b 100644 --- a/content/id/docs/tasks/run-application/run-stateless-application-deployment.md +++ b/content/id/docs/tasks/run-application/run-stateless-application-deployment.md @@ -51,7 +51,6 @@ YAML berikut mendeskripsikan sebuah Deployment yang menjalankan _image_ Docker n Keluaran dari perintah tersebut akan menyerupai: - user@computer:~/website$ kubectl describe deployment nginx-deployment Name: nginx-deployment Namespace: default CreationTimestamp: Tue, 30 Aug 2016 18:11:37 -0700 From c38481d348cf18705a2ba9485347b1057e976f5b Mon Sep 17 00:00:00 2001 From: Zhang Yong Date: Sun, 28 Mar 2021 10:17:30 +0800 Subject: [PATCH 039/104] Explicitly specify kubernetes system daemons in doc --- .../tasks/administer-cluster/reserve-compute-resources.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/zh/docs/tasks/administer-cluster/reserve-compute-resources.md b/content/zh/docs/tasks/administer-cluster/reserve-compute-resources.md index 381697d352..ec8272af3e 100644 --- a/content/zh/docs/tasks/administer-cluster/reserve-compute-resources.md +++ b/content/zh/docs/tasks/administer-cluster/reserve-compute-resources.md @@ -160,7 +160,7 @@ kubernetes 系统守护进程记述其资源预留值。 kubernetes 系统守护进程预留指定数量的进程 ID。 -要选择性地对系统守护进程上执行 `kube-reserved` 保护,需要把 kubelet 的 +要选择性地对 kubernetes 系统守护进程上执行 `kube-reserved` 保护,需要把 kubelet 的 `--kube-reserved-cgroup` 标志的值设置为 kube 守护进程的父控制组。 推荐将 kubernetes 系统守护进程放置于顶级控制组之下(例如 systemd 机器上的 From 0a1759001497f64f8df0d44705cf0eb1024e3f2c Mon Sep 17 00:00:00 2001 From: Zhang Yong Date: Sun, 28 Mar 2021 10:40:20 +0800 Subject: [PATCH 040/104] Fix line separation in concepts/architecture/nodes --- content/zh/docs/concepts/architecture/nodes.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/content/zh/docs/concepts/architecture/nodes.md b/content/zh/docs/concepts/architecture/nodes.md index 908b8ddde6..8536916268 100644 --- a/content/zh/docs/concepts/architecture/nodes.md +++ b/content/zh/docs/concepts/architecture/nodes.md @@ -432,14 +432,16 @@ ConditionUnknown when a node becomes unreachable (i.e. the node controller stops receiving heartbeats for some reason, e.g. due to the node being down), and then later evicting all the pods from the node (using graceful termination) if the node continues to be unreachable. (The default timeouts are 40s to start reporting -ConditionUnknown and 5m after that to start evicting pods.) The node controller -checks the state of each node every `-node-monitor-period` seconds. +ConditionUnknown and 5m after that to start evicting pods.) + +The node controller checks the state of each node every `-node-monitor-period` seconds. --> 第三个是监控节点的健康情况。节点控制器负责在节点不可达 (即,节点控制器因为某些原因没有收到心跳,例如节点宕机)时, 将节点状态的 `NodeReady` 状况更新为 "`Unknown`"。 如果节点接下来持续处于不可达状态,节点控制器将逐出节点上的所有 Pod(使用体面终止)。 默认情况下 40 秒后开始报告 "`Unknown`",在那之后 5 分钟开始逐出 Pod。 + 节点控制器每隔 `--node-monitor-period` 秒检查每个节点的状态。 + +볼륨 플러그인을 사용하면 {{< glossary_tooltip text="파드" term_id="pod" >}}에서 사용할 스토리지 볼륨을 연결하고 마운트할 수 있다. 볼륨 플러그인은 _인-트리(in tree)_ 혹은 _아웃-오브-트리(out of tree)_ 일 수 있다. _인-트리_ 플러그인은 쿠버네티스 코드 리포지터리의 일부이며 동일한 릴리즈 주기를 따른다. _아웃-오브-트리_ 플러그인은 독립적으로 개발된다. + From ecede1568a06038091ff5f46a6118b940d421656 Mon Sep 17 00:00:00 2001 From: Xiaopeng Han Date: Mon, 29 Mar 2021 11:54:32 +0800 Subject: [PATCH 048/104] update the correct operator link The original link of `operator pattern` is a meaningless page. This commit updates the link to the correct `operator pattern` page. --- .../extend-kubernetes/api-extension/custom-resources.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/concepts/extend-kubernetes/api-extension/custom-resources.md b/content/en/docs/concepts/extend-kubernetes/api-extension/custom-resources.md index 5457dc9204..f37a71f278 100644 --- a/content/en/docs/concepts/extend-kubernetes/api-extension/custom-resources.md +++ b/content/en/docs/concepts/extend-kubernetes/api-extension/custom-resources.md @@ -44,7 +44,7 @@ desired state, and continually maintains this state. You can deploy and update a custom controller on a running cluster, independently of the cluster's lifecycle. Custom controllers can work with any kind of resource, but they are especially effective when combined with custom resources. The -[Operator pattern](https://coreos.com/blog/introducing-operators.html) combines custom +[Operator pattern](/docs/concepts/extend-kubernetes/operator/) combines custom resources and custom controllers. You can use custom controllers to encode domain knowledge for specific applications into an extension of the Kubernetes API. From 5c589626fd27950e231022b089eb0ff3fa166671 Mon Sep 17 00:00:00 2001 From: ganeshniyer Date: Mon, 29 Mar 2021 14:04:48 +0530 Subject: [PATCH 049/104] Made small typo corrections (1) the help option for etcdctl is -h and not --h. Corrected the same (2) in the snapshot command, the --endpoints option's value has been corrected to reflect the right endpoint. --- .../docs/tasks/administer-cluster/configure-upgrade-etcd.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/docs/tasks/administer-cluster/configure-upgrade-etcd.md b/content/en/docs/tasks/administer-cluster/configure-upgrade-etcd.md index 5dee2ae185..f626d4d1b6 100644 --- a/content/en/docs/tasks/administer-cluster/configure-upgrade-etcd.md +++ b/content/en/docs/tasks/administer-cluster/configure-upgrade-etcd.md @@ -283,14 +283,14 @@ volume. We can also take the snapshot using various options given by etcdctl. For example ```shell -ETCDCTL_API=3 etcdctl --h +ETCDCTL_API=3 etcdctl -h ``` will list various options available from etcdctl. For example, you can take a snapshot by specifying the endpoint, certificates etc as shown below: ```shell -ETCDCTL_API=3 etcdctl --endpoints=[127.0.0.1:2379] \ +ETCDCTL_API=3 etcdctl --endpoints=https://[127.0.0.1]:2379 \ --cacert= --cert= --key= \ snapshot save ``` From ed7c4e7046c0b02df3f7e133a62fe17fe2ac2f53 Mon Sep 17 00:00:00 2001 From: pacoxu Date: Wed, 17 Mar 2021 11:34:40 +0800 Subject: [PATCH 050/104] init container image change or container GC will not restart Pod since 1.20 Signed-off-by: pacoxu --- .../en/docs/concepts/workloads/pods/init-containers.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/content/en/docs/concepts/workloads/pods/init-containers.md b/content/en/docs/concepts/workloads/pods/init-containers.md index 363c38a39b..1c67e357e5 100644 --- a/content/en/docs/concepts/workloads/pods/init-containers.md +++ b/content/en/docs/concepts/workloads/pods/init-containers.md @@ -313,16 +313,16 @@ limit, the same as the scheduler. A Pod can restart, causing re-execution of init containers, for the following reasons: -* A user updates the Pod specification, causing the init container image to change. - Any changes to the init container image restarts the Pod. App container image - changes only restart the app container. * The Pod infrastructure container is restarted. This is uncommon and would have to be done by someone with root access to nodes. * All containers in a Pod are terminated while `restartPolicy` is set to Always, forcing a restart, and the init container completion record has been lost due to garbage collection. - +The Pod will not be restarted when the init container image is changed, or the +init container completion record has been lost due to garbage collection. This +applies for Kubernetes v1.20 and later. If you are using an earlier version of +Kubernetes, consult the documentation for the version you are using. ## {{% heading "whatsnext" %}} From 1dbdda9d3448f5b1edb506e8a201717babf4a334 Mon Sep 17 00:00:00 2001 From: Qiming Teng Date: Mon, 29 Mar 2021 18:57:31 +0800 Subject: [PATCH 051/104] [zh] Resync cluster administration Main change is to the certificates page which has been migrated into its own task. --- .../concepts/cluster-administration/_index.md | 10 +- .../cluster-administration/certificates.md | 505 +----------------- .../cluster-administration/flow-control.md | 2 +- .../manage-deployment.md | 28 +- .../cluster-administration/proxies.md | 2 +- .../cluster-administration/system-logs.md | 13 +- 6 files changed, 32 insertions(+), 528 deletions(-) diff --git a/content/zh/docs/concepts/cluster-administration/_index.md b/content/zh/docs/concepts/cluster-administration/_index.md index d1fde6c86c..36e27269f7 100644 --- a/content/zh/docs/concepts/cluster-administration/_index.md +++ b/content/zh/docs/concepts/cluster-administration/_index.md @@ -51,12 +51,12 @@ Before choosing a guide, here are some considerations: 在选择一个指南前,有一些因素需要考虑: ## 保护集群 {#securing-a-cluster} -* [证书](/zh/docs/concepts/cluster-administration/certificates/) +* [生成证书](/zh/docs/tasks/administer-cluster/certificates/) 节描述了使用不同的工具链生成证书的步骤。 * [Kubernetes 容器环境](/zh/docs/concepts/containers/container-environment/) 描述了 Kubernetes 节点上由 Kubelet 管理的容器的环境。 diff --git a/content/zh/docs/concepts/cluster-administration/certificates.md b/content/zh/docs/concepts/cluster-administration/certificates.md index fe2d6e4ba1..b900e77ec9 100644 --- a/content/zh/docs/concepts/cluster-administration/certificates.md +++ b/content/zh/docs/concepts/cluster-administration/certificates.md @@ -12,508 +12,7 @@ weight: 20 -当使用客户端证书进行认证时,用户可以使用现有部署脚本,或者通过 `easyrsa`、`openssl` 或 -`cfssl` 手动生成证书。 - - - -### easyrsa - - -使用 **easyrsa** 能够手动地为集群生成证书。 - - - -1. 下载、解压并初始化 easyrsa3 的补丁版本。 - - ``` - curl -LO https://storage.googleapis.com/kubernetes-release/easy-rsa/easy-rsa.tar.gz - tar xzf easy-rsa.tar.gz - cd easy-rsa-master/easyrsa3 - ./easyrsa init-pki - ``` - -1. 生成 CA(通过 `--batch` 参数设置自动模式。 通过 `--req-cn` 设置默认使用的 CN) - - ``` - ./easyrsa --batch "--req-cn=${MASTER_IP}@`date +%s`" build-ca nopass - ``` - -1. 生成服务器证书和密钥。 - 参数 `--subject-alt-name` 设置了访问 API 服务器时可能使用的 IP 和 DNS 名称。 - `MASTER_CLUSTER_IP` 通常为 `--service-cluster-ip-range` 参数中指定的服务 CIDR 的 首个 IP 地址, - `--service-cluster-ip-range` 同时用于 API 服务器和控制器管理器组件。 - `--days` 参数用于设置证书的有效期限。 - 下面的示例还假设用户使用 `cluster.local` 作为默认的 DNS 域名。 - - ``` - ./easyrsa --subject-alt-name="IP:${MASTER_IP},"\ - "IP:${MASTER_CLUSTER_IP},"\ - "DNS:kubernetes,"\ - "DNS:kubernetes.default,"\ - "DNS:kubernetes.default.svc,"\ - "DNS:kubernetes.default.svc.cluster,"\ - "DNS:kubernetes.default.svc.cluster.local" \ - --days=10000 \ - build-server-full server nopass - ``` - -1. 拷贝 `pki/ca.crt`、`pki/issued/server.crt` 和 `pki/private/server.key` 至您的目录。 - -1. 填充并在 API 服务器的启动参数中添加以下参数: - - ``` - --client-ca-file=/yourdirectory/ca.crt - --tls-cert-file=/yourdirectory/server.crt - --tls-private-key-file=/yourdirectory/server.key - ``` - -### openssl - - - -使用 **openssl** 能够手动地为集群生成证书。 - -1. 生成密钥位数为 2048 的 ca.key: - - ``` - openssl genrsa -out ca.key 2048 - ``` - -1. 依据 ca.key 生成 ca.crt (使用 -days 参数来设置证书有效时间): - - ``` - openssl req -x509 -new -nodes -key ca.key -subj "/CN=${MASTER_IP}" -days 10000 -out ca.crt - ``` - -1. 生成密钥位数为 2048 的 server.key: - - ``` - openssl genrsa -out server.key 2048 - ``` -1. 创建用于生成证书签名请求(CSR)的配置文件。 - 确保在将其保存至文件(如 `csr.conf`)之前将尖括号标记的值(如 ``) - 替换为你想使用的真实值。 注意:`MASTER_CLUSTER_IP` 是前面小节中描述的 API 服务器的服务集群 IP - (service cluster IP)。 下面的示例也假设用户使用 `cluster.local` 作为默认的 DNS 域名。 - - ``` - [ req ] - default_bits = 2048 - prompt = no - default_md = sha256 - req_extensions = req_ext - distinguished_name = dn - - [ dn ] - C = <国家> - ST = <州/省> - L = <市> - O = <组织> - OU = <部门> - CN = - - [ req_ext ] - subjectAltName = @alt_names - - [ alt_names ] - DNS.1 = kubernetes - DNS.2 = kubernetes.default - DNS.3 = kubernetes.default.svc - DNS.4 = kubernetes.default.svc.cluster - DNS.5 = kubernetes.default.svc.cluster.local - IP.1 = - IP.2 = - - [ v3_ext ] - authorityKeyIdentifier=keyid,issuer:always - basicConstraints=CA:FALSE - keyUsage=keyEncipherment,dataEncipherment - extendedKeyUsage=serverAuth,clientAuth - subjectAltName=@alt_names - ``` - -1. 基于配置文件生成证书签名请求: - - ``` - openssl req -new -key server.key -out server.csr -config csr.conf - ``` - -1. 使用 ca.key、ca.crt 和 server.csr 生成服务器证书: - - ``` - openssl x509 -req -in server.csr -CA ca.crt -CAkey ca.key \ - -CAcreateserial -out server.crt -days 10000 \ - -extensions v3_ext -extfile csr.conf - ``` - -1. 查看证书: - - ``` - openssl x509 -noout -text -in ./server.crt - ``` - - -最后,添加同样的参数到 API 服务器的启动参数中。 - -### cfssl - - -**cfssl** 是用来生成证书的另一种工具。 - - -1. 按如下所示的方式下载、解压并准备命令行工具。 - 注意:你可能需要基于硬件架构和你所使用的 cfssl 版本对示例命令进行修改。 - - ``` - curl -L https://pkg.cfssl.org/R1.2/cfssl_linux-amd64 -o cfssl - chmod +x cfssl - curl -L https://pkg.cfssl.org/R1.2/cfssljson_linux-amd64 -o cfssljson - chmod +x cfssljson - curl -L https://pkg.cfssl.org/R1.2/cfssl-certinfo_linux-amd64 -o cfssl-certinfo - chmod +x cfssl-certinfo - ``` - -1. 创建目录来存放物料,并初始化 cfssl: - - ``` - mkdir cert - cd cert - ../cfssl print-defaults config > config.json - ../cfssl print-defaults csr > csr.json - ``` - -1. 创建用来生成 CA 文件的 JSON 配置文件,例如 `ca-config.json`: - - ``` - { - "signing": { - "default": { - "expiry": "8760h" - }, - "profiles": { - "kubernetes": { - "usages": [ - "signing", - "key encipherment", - "server auth", - "client auth" - ], - "expiry": "8760h" - } - } - } - } - ``` - -1. 创建用来生成 CA 证书签名请求(CSR)的 JSON 配置文件,例如 `ca-csr.json`。 - 确保将尖括号标记的值替换为你想使用的真实值。 - - ``` - { - "CN": "kubernetes", - "key": { - "algo": "rsa", - "size": 2048 - }, - "names":[{ - "C": "", - "ST": "", - "L": "", - "O": "", - "OU": "" - }] - } - ``` - -1. 生成 CA 密钥(`ca-key.pem`)和证书(`ca.pem`): - - ``` - ../cfssl gencert -initca ca-csr.json | ../cfssljson -bare ca - ``` - -1. 按如下所示的方式创建用来为 API 服务器生成密钥和证书的 JSON 配置文件。 - 确保将尖括号标记的值替换为你想使用的真实值。 `MASTER_CLUSTER_IP` 是前面小节中描述的 - API 服务器的服务集群 IP。 下面的示例也假设用户使用 `cluster.local` 作为默认的 DNS 域名。 - - ``` - { - "CN": "kubernetes", - "hosts": [ - "127.0.0.1", - "", - "", - "kubernetes", - "kubernetes.default", - "kubernetes.default.svc", - "kubernetes.default.svc.cluster", - "kubernetes.default.svc.cluster.local" - ], - "key": { - "algo": "rsa", - "size": 2048 - }, - "names": [{ - "C": "", - "ST": "", - "L": "", - "O": "", - "OU": "" - }] - } - ``` - -1. 为 API 服务器生成密钥和证书,生成的秘钥和证书分别默认保存在文件 `server-key.pem` - 和 `server.pem` 中: - - ``` - ../cfssl gencert -ca=ca.pem -ca-key=ca-key.pem \ - --config=ca-config.json -profile=kubernetes \ - server-csr.json | ../cfssljson -bare server - ``` - - -## 分发自签名 CA 证书 - -客户端节点可能拒绝承认自签名 CA 证书有效。 -对于非生产环境的部署,或运行在企业防火墙后的部署,用户可以向所有客户端分发自签名 CA 证书, -并刷新本地的有效证书列表。 - -在每个客户端上执行以下操作: - -```bash -sudo cp ca.crt /usr/local/share/ca-certificates/kubernetes.crt -sudo update-ca-certificates -``` - -``` -Updating certificates in /etc/ssl/certs... -1 added, 0 removed; done. -Running hooks in /etc/ca-certificates/update.d.... -done. -``` - - -## 证书 API - -您可以按照[这里](/zh/docs/tasks/tls/managing-tls-in-a-cluster)记录的方式, -使用 `certificates.k8s.io` API 来准备 x509 证书,用于认证。 - +要了解如何为集群生成证书,参阅[证书](/zh/docs/tasks/administer-cluster/certificates/)。 diff --git a/content/zh/docs/concepts/cluster-administration/flow-control.md b/content/zh/docs/concepts/cluster-administration/flow-control.md index 7dde282034..dd994b358b 100644 --- a/content/zh/docs/concepts/cluster-administration/flow-control.md +++ b/content/zh/docs/concepts/cluster-administration/flow-control.md @@ -762,7 +762,7 @@ poorly-behaved workloads that may be harming system health. histogram vector of queue lengths for the queues, broken down by the labels `priority_level` and `flow_schema`, as sampled by the enqueued requests. Each request that gets queued contributes one - sample to its histogram, reporting the length of the queue just + sample to its histogram, reporting the length of the queue immediately after the request was added. Note that this produces different statistics than an unbiased survey would. --> diff --git a/content/zh/docs/concepts/cluster-administration/manage-deployment.md b/content/zh/docs/concepts/cluster-administration/manage-deployment.md index 71ece48b8a..e28da08081 100644 --- a/content/zh/docs/concepts/cluster-administration/manage-deployment.md +++ b/content/zh/docs/concepts/cluster-administration/manage-deployment.md @@ -72,7 +72,7 @@ kubectl apply -f https://k8s.io/examples/application/nginx/ @@ -80,7 +80,7 @@ A URL can also be specified as a configuration source, which is handy for deploy 建议的做法是,将同一个微服务或同一应用层相关的资源放到同一个文件中, 将同一个应用相关的所有文件按组存放到同一个目录中。 -如果应用的各层使用 DNS 相互绑定,那么你可以简单地将堆栈的所有组件一起部署。 +如果应用的各层使用 DNS 相互绑定,那么你可以将堆栈的所有组件一起部署。 还可以使用 URL 作为配置源,便于直接使用已经提交到 Github 上的配置文件进行部署: @@ -113,7 +113,7 @@ service "my-nginx-svc" deleted ``` 在仅有两种资源的情况下,可以使用"资源类型/资源名"的语法在命令行中 同时指定这两个资源: @@ -138,13 +138,14 @@ service "my-nginx-svc" deleted ``` 由于 `kubectl` 用来输出资源名称的语法与其所接受的资源名称语法相同, -所以很容易使用 `$()` 或 `xargs` 进行链式操作: +你可以使用 `$()` 或 `xargs` 进行链式操作: ```shell kubectl get $(kubectl create -f docs/concepts/cluster-administration/nginx/ -o name | grep service) +kubectl create -f docs/concepts/cluster-administration/nginx/ -o name | grep service | xargs -i kubectl get {} ``` ``` @@ -399,13 +400,13 @@ For a more concrete example, check the [tutorial of deploying Ghost](https://git ## Updating labels Sometimes existing pods and other resources need to be relabeled before creating new resources. This can be done with `kubectl label`. -For example, if you want to label all your nginx pods as frontend tier, simply run: +For example, if you want to label all your nginx pods as frontend tier, run: --> ## 更新标签 {#updating-labels} 有时,现有的 pod 和其它资源需要在创建新资源之前重新标记。 这可以用 `kubectl label` 完成。 -例如,如果想要将所有 nginx pod 标记为前端层,只需运行: +例如,如果想要将所有 nginx pod 标记为前端层,运行: ```shell kubectl label pods -l app=nginx tier=fe @@ -419,7 +420,7 @@ pod/my-nginx-2035384211-u3t6x labeled 首先用标签 "app=nginx" 过滤所有的 Pod,然后用 "tier=fe" 标记它们。 想要查看你刚才标记的 Pod,请运行: @@ -482,11 +483,11 @@ For more information, please see [annotations](/docs/concepts/overview/working-w ## 扩缩你的应用 -当应用上的负载增长或收缩时,使用 `kubectl` 能够轻松实现规模的扩缩。 +当应用上的负载增长或收缩时,使用 `kubectl` 能够实现应用规模的扩缩。 例如,要将 nginx 副本的数量从 3 减少到 1,请执行以下操作: ```shell @@ -505,6 +506,7 @@ Now you only have one pod managed by the deployment. ```shell kubectl get pods -l app=nginx ``` + ``` NAME READY STATUS RESTARTS AGE my-nginx-2035384211-j5fhi 1/1 Running 0 30m @@ -653,13 +655,13 @@ JSON merge patch、以及 strategic merge patch。 请参考 ## 破坏性的更新 {#disruptive-updates} 在某些情况下,你可能需要更新某些初始化后无法更新的资源字段,或者你可能只想立即进行递归更改, 例如修复 Deployment 创建的不正常的 Pod。若要更改这些字段,请使用 `replace --force`, -它将删除并重新创建资源。在这种情况下,你可以简单地修改原始配置文件: +它将删除并重新创建资源。在这种情况下,你可以修改原始配置文件: ```shell kubectl replace -f https://k8s.io/examples/application/nginx/nginx-deployment.yaml --force @@ -700,7 +702,7 @@ deployment.apps/my-nginx created ``` 要更新到 1.16.1 版本,只需使用我们前面学到的 kubectl 命令将 `.spec.template.spec.containers[0].image` 从 `nginx:1.14.2` 修改为 `nginx:1.16.1`。 diff --git a/content/zh/docs/concepts/cluster-administration/proxies.md b/content/zh/docs/concepts/cluster-administration/proxies.md index 808d8b31ec..be933ccc9c 100644 --- a/content/zh/docs/concepts/cluster-administration/proxies.md +++ b/content/zh/docs/concepts/cluster-administration/proxies.md @@ -73,7 +73,7 @@ There are several different proxies you may encounter when using Kubernetes: - proxies UDP, TCP and SCTP - does not understand HTTP - provides load balancing - - is just used to reach services + - is only used to reach services --> 3. [kube proxy](/zh/docs/concepts/services-networking/service/#ips-and-vips): diff --git a/content/zh/docs/concepts/cluster-administration/system-logs.md b/content/zh/docs/concepts/cluster-administration/system-logs.md index 799b566f6a..4fb9ba7c89 100644 --- a/content/zh/docs/concepts/cluster-administration/system-logs.md +++ b/content/zh/docs/concepts/cluster-administration/system-logs.md @@ -59,7 +59,7 @@ Migration to structured log messages is an ongoing process. Not all log messages Log formatting and value serialization are subject to change. --> -{{}} +{{< warning >}} 到结构化日志消息的迁移是一个持续的过程。 在此版本中,并非所有日志消息都是结构化的。 解析日志文件时,你也必须要处理非结构化日志消息。 @@ -68,22 +68,25 @@ Log formatting and value serialization are subject to change. {{< /warning>}} -结构化日志记录旨在日志消息中引入统一结构,以方便提取信息,使日志的存储和处理更容易、成本更低。 +结构化日志记录旨在日志消息中引入统一结构,以便以编程方式提取信息。 +你可以方便地用更小的开销来处理结构化日志。 新的消息格式向后兼容,并默认启用。 结构化日志的格式: -``` + +```ini "" ="" ="" ... ``` 示例: -``` + +```ini I1025 00:15:15.525108 1 controller_utils.go:116] "Pod status updated" pod="kube-system/kubedns" status="ready" ``` From 89a2aec131d5fceeab3ae7ad03c3ebd2023ff631 Mon Sep 17 00:00:00 2001 From: huyuqing Date: Mon, 29 Mar 2021 19:19:15 +0800 Subject: [PATCH 052/104] Translation optimization of /docs/tasks/job/automated-tasks-with-cron-jobs.md --- content/zh/docs/tasks/job/automated-tasks-with-cron-jobs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/zh/docs/tasks/job/automated-tasks-with-cron-jobs.md b/content/zh/docs/tasks/job/automated-tasks-with-cron-jobs.md index b3e08e73c0..1d417c6e65 100644 --- a/content/zh/docs/tasks/job/automated-tasks-with-cron-jobs.md +++ b/content/zh/docs/tasks/job/automated-tasks-with-cron-jobs.md @@ -360,7 +360,7 @@ By default, they are set to 3 and 1 respectively. Setting a limit to `0` corres ### 任务历史限制 `.spec.successfulJobsHistoryLimit` 和 `.spec.failedJobsHistoryLimit`是可选的。 -这两个域声明了有多少执行完成和失败的任务会被保留。 +这两个字段指定应保留多少已完成和失败的作业。 默认设置为3和1。限制设置为0代表相应类型的任务完成后不会保留。 From 66617a0633b518fe9e062d94ef8576620ad4d0be Mon Sep 17 00:00:00 2001 From: huyuqing Date: Mon, 29 Mar 2021 19:25:30 +0800 Subject: [PATCH 053/104] Translation optimization of /docs/tasks/job/automated-tasks-with-cron-jobs.md --- content/zh/docs/tasks/job/automated-tasks-with-cron-jobs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/zh/docs/tasks/job/automated-tasks-with-cron-jobs.md b/content/zh/docs/tasks/job/automated-tasks-with-cron-jobs.md index 1d417c6e65..ccf573b155 100644 --- a/content/zh/docs/tasks/job/automated-tasks-with-cron-jobs.md +++ b/content/zh/docs/tasks/job/automated-tasks-with-cron-jobs.md @@ -360,7 +360,7 @@ By default, they are set to 3 and 1 respectively. Setting a limit to `0` corres ### 任务历史限制 `.spec.successfulJobsHistoryLimit` 和 `.spec.failedJobsHistoryLimit`是可选的。 -这两个字段指定应保留多少已完成和失败的作业。 +这两个字段指定应保留多少已完成和失败的任务。 默认设置为3和1。限制设置为0代表相应类型的任务完成后不会保留。 From 29d6c1135d50b9b01de10686d00ef1ff40f18e9c Mon Sep 17 00:00:00 2001 From: Qiming Teng Date: Mon, 29 Mar 2021 20:43:52 +0800 Subject: [PATCH 054/104] [zh] Sync changes to workload controllers --- .../workloads/controllers/cron-jobs.md | 8 ++++++ .../workloads/controllers/daemonset.md | 4 +-- .../workloads/controllers/deployment.md | 27 ++++++++++--------- .../concepts/workloads/controllers/job.md | 2 +- .../workloads/controllers/replicaset.md | 6 ++--- .../controllers/replicationcontroller.md | 25 +++++++++-------- 6 files changed, 42 insertions(+), 30 deletions(-) diff --git a/content/zh/docs/concepts/workloads/controllers/cron-jobs.md b/content/zh/docs/concepts/workloads/controllers/cron-jobs.md index a987270233..21eb03385c 100644 --- a/content/zh/docs/concepts/workloads/controllers/cron-jobs.md +++ b/content/zh/docs/concepts/workloads/controllers/cron-jobs.md @@ -154,6 +154,14 @@ at least once. 如果 `startingDeadlineSeconds` 设置为很大的数值或未设置(默认),并且 `concurrencyPolicy` 设置为 `Allow`,则作业将始终至少运行一次。 +{{< caution >}} + +如果 `startingDeadlineSeconds` 的设置值低于 10 秒钟,CronJob 可能无法被调度。 +这是因为 CronJob 控制器每 10 秒钟执行一次检查。 +{{< /caution >}} + diff --git a/content/zh/docs/concepts/workloads/controllers/daemonset.md b/content/zh/docs/concepts/workloads/controllers/daemonset.md index 60f8f656fe..6ad8c561d9 100644 --- a/content/zh/docs/concepts/workloads/controllers/daemonset.md +++ b/content/zh/docs/concepts/workloads/controllers/daemonset.md @@ -278,8 +278,8 @@ the related features. | ---------------------------------------- | ---------- | ------- | ------------------------------------------------------------ | | `node.kubernetes.io/not-ready` | NoExecute | 1.13+ | 当出现类似网络断开的情况导致节点问题时,DaemonSet Pod 不会被逐出。 | | `node.kubernetes.io/unreachable` | NoExecute | 1.13+ | 当出现类似于网络断开的情况导致节点问题时,DaemonSet Pod 不会被逐出。 | -| `node.kubernetes.io/disk-pressure` | NoSchedule | 1.8+ | | -| `node.kubernetes.io/memory-pressure` | NoSchedule | 1.8+ | | +| `node.kubernetes.io/disk-pressure` | NoSchedule | 1.8+ | DaemonSet Pod 被默认调度器调度时能够容忍磁盘压力属性。 | +| `node.kubernetes.io/memory-pressure` | NoSchedule | 1.8+ | DaemonSet Pod 被默认调度器调度时能够容忍内存压力属性。 | | `node.kubernetes.io/unschedulable` | NoSchedule | 1.12+ | DaemonSet Pod 能够容忍默认调度器所设置的 `unschedulable` 属性. | | `node.kubernetes.io/network-unavailable` | NoSchedule | 1.12+ | DaemonSet 在使用宿主网络时,能够容忍默认调度器所设置的 `network-unavailable` 属性。 | diff --git a/content/zh/docs/concepts/workloads/controllers/deployment.md b/content/zh/docs/concepts/workloads/controllers/deployment.md index 14214e7066..0f6ea1846f 100644 --- a/content/zh/docs/concepts/workloads/controllers/deployment.md +++ b/content/zh/docs/concepts/workloads/controllers/deployment.md @@ -102,24 +102,25 @@ In this example: * `selector` 字段定义 Deployment 如何查找要管理的 Pods。 - 在这里,你只需选择在 Pod 模板中定义的标签(`app: nginx`)。 + 在这里,你选择在 Pod 模板中定义的标签(`app: nginx`)。 不过,更复杂的选择规则是也可能的,只要 Pod 模板本身满足所给规则即可。 + {{< note >}} - {{< note >}} - `matchLabels` 字段是 `{key,value}` 偶对的映射。在 `matchLabels` 映射中的单个 `{key,value}` - 映射等效于 `matchExpressions` 中的一个元素,即其 `key` 字段是 “key”,operator 为 “In”,`value` - 数组仅包含 “value”。在 `matchLabels` 和 `matchExpressions` 中给出的所有条件都必须满足才能匹配。 + `spec.selector.matchLabels` 字段是 `{key,value}` 键值对映射。 + 在 `matchLabels` 映射中的每个 `{key,value}` 映射等效于 `matchExpressions` 中的一个元素, + 即其 `key` 字段是 “key”,`operator` 为 “In”,`values` 数组仅包含 “value”。 + 在 `matchLabels` 和 `matchExpressions` 中给出的所有条件都必须满足才能匹配。 {{< /note >}} 或者使用下面的命令: @@ -355,7 +356,7 @@ is changed, for example if the labels or container images of the template are up kubectl set image deployment/nginx-deployment nginx=nginx:1.16.1 --record ``` - + 输出类似于: ``` @@ -429,7 +430,7 @@ up to 3 replicas, as well as scaling down the old ReplicaSet to 0 replicas. kubectl get rs ``` - + 输出类似于: ``` @@ -1179,7 +1180,7 @@ apply multiple fixes in between pausing and resuming without triggering unnecess 这样做使得你能够在暂停和恢复执行之间应用多个修补程序,而不会触发不必要的上线操作。 * 例如,对于一个刚刚创建的 Deployment: diff --git a/content/zh/docs/concepts/workloads/controllers/job.md b/content/zh/docs/concepts/workloads/controllers/job.md index 6180d3bd28..a2a6982e54 100644 --- a/content/zh/docs/concepts/workloads/controllers/job.md +++ b/content/zh/docs/concepts/workloads/controllers/job.md @@ -139,7 +139,7 @@ pi-5rwd7 diff --git a/content/zh/docs/concepts/workloads/controllers/replicaset.md b/content/zh/docs/concepts/workloads/controllers/replicaset.md index 46877b02f6..7ad68c9e53 100644 --- a/content/zh/docs/concepts/workloads/controllers/replicaset.md +++ b/content/zh/docs/concepts/workloads/controllers/replicaset.md @@ -345,7 +345,7 @@ pod2 1/1 Running 0 36s ## Writing a ReplicaSet Spec As with all other Kubernetes API objects, a ReplicaSet needs the `apiVersion`, `kind`, and `metadata` fields. -For ReplicaSets, the kind is always just ReplicaSet. +For ReplicaSets, the `kind` is always a ReplicaSet. In Kubernetes 1.9 the API version `apps/v1` on the ReplicaSet kind is the current version and is enabled by default. The API version `apps/v1beta2` is deprecated. Refer to the first lines of the `frontend.yaml` example for guidance. @@ -357,7 +357,7 @@ A ReplicaSet also needs a [`.spec` section](https://git.k8s.io/community/contrib ## 编写 ReplicaSet 的 spec 与所有其他 Kubernetes API 对象一样,ReplicaSet 也需要 `apiVersion`、`kind`、和 `metadata` 字段。 -对于 ReplicaSets 而言,其 kind 始终是 ReplicaSet。 +对于 ReplicaSets 而言,其 `kind` 始终是 ReplicaSet。 在 Kubernetes 1.9 中,ReplicaSet 上的 API 版本 `apps/v1` 是其当前版本,且被 默认启用。API 版本 `apps/v1beta2` 已被废弃。 参考 `frontend.yaml` 示例的第一行。 @@ -375,7 +375,7 @@ The `.spec.template` is a [pod template](/docs/concepts/workloads/pods/#pod-temp required to have labels in place. In our `frontend.yaml` example we had one label: `tier: frontend`. Be careful not to overlap with the selectors of other controllers, lest they try to adopt this Pod. -For the template's [restart policy](/docs/concepts/workloads/Pods/pod-lifecycle/#restart-policy) field, +For the template's [restart policy](/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy) field, `.spec.template.spec.restartPolicy`, the only allowed value is `Always`, which is the default. --> ### Pod 模版 diff --git a/content/zh/docs/concepts/workloads/controllers/replicationcontroller.md b/content/zh/docs/concepts/workloads/controllers/replicationcontroller.md index dee9e01912..c35032aa28 100644 --- a/content/zh/docs/concepts/workloads/controllers/replicationcontroller.md +++ b/content/zh/docs/concepts/workloads/controllers/replicationcontroller.md @@ -174,10 +174,10 @@ nginx-3ntk0 nginx-4ok8v nginx-qrm3m 这里,选择算符与 ReplicationController 的选择算符相同(参见 `kubectl describe` 输出),并以不同的形式出现在 `replication.yaml` 中。 -`--output=jsonpath` 选项指定了一个表达式,只从返回列表中的每个 Pod 中获取名称。 +`--output=jsonpath` 选项指定了一个表达式,仅从返回列表中的每个 Pod 中获取名称。 ## 使用 ReplicationController {#working-with-replicationcontrollers} @@ -317,16 +317,17 @@ When using the REST API or go client library, you need to do the steps explicitl kubectl 将 ReplicationController 缩放为 0 并等待以便在删除 ReplicationController 本身之前删除每个 Pod。 如果这个 kubectl 命令被中断,可以重新启动它。 -当使用 REST API 或 go 客户端库时,你需要明确地执行这些步骤(缩放副本为 0、 等待 Pod 删除,之后删除 ReplicationController 资源)。 +当使用 REST API 或 Go 客户端库时,你需要明确地执行这些步骤(缩放副本为 0、 +等待 Pod 删除,之后删除 ReplicationController 资源)。 ### 只删除 ReplicationController @@ -334,7 +335,7 @@ When using the REST API or go client library, simply delete the ReplicationContr 使用 kubectl,为 [`kubectl delete`](/docs/reference/generated/kubectl/kubectl-commands#delete) 指定 `--cascade=false` 选项。 -当使用 REST API 或 go 客户端库时,只需删除 ReplicationController 对象。 +当使用 REST API 或 Go 客户端库时,只需删除 ReplicationController 对象。 ### 扩缩容 {#scaling} -通过简单地更新 `replicas` 字段,ReplicationController 可以方便地横向扩容或缩容副本的数量,或手动或通过自动缩放控制代理。 +通过设置 `replicas` 字段,ReplicationController 可以方便地横向扩容或缩容副本的数量。 +你可以手动或通过自动缩放控制代理来控制 ReplicationController 执行此操作。 ## ReplicationController 的职责 -ReplicationController 只需确保所需的 Pod 数量与其标签选择算符匹配,并且是可操作的。 +ReplicationController 仅确保所需的 Pod 数量与其标签选择算符匹配,并且是可操作的。 目前,它的计数中只排除终止的 Pod。 未来,可能会考虑系统提供的[就绪状态](https://issue.k8s.io/620)和其他信息, 我们可能会对替换策略添加更多控制, From 3252fb1d9e1869624a7e8f3204b8bb4ad920f787 Mon Sep 17 00:00:00 2001 From: SataQiu <1527062125@qq.com> Date: Mon, 29 Mar 2021 20:56:15 +0800 Subject: [PATCH 055/104] kubeadm: update create-cluster-kubeadm page as kubeadm will not do e2e tests against Calico CNI anymore --- .../tools/kubeadm/create-cluster-kubeadm.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/setup/production-environment/tools/kubeadm/create-cluster-kubeadm.md b/content/en/docs/setup/production-environment/tools/kubeadm/create-cluster-kubeadm.md index a9b37e8167..a5cdecafd7 100644 --- a/content/en/docs/setup/production-environment/tools/kubeadm/create-cluster-kubeadm.md +++ b/content/en/docs/setup/production-environment/tools/kubeadm/create-cluster-kubeadm.md @@ -229,7 +229,7 @@ Cluster DNS (CoreDNS) will not start up before a network is installed.** {{< /caution >}} {{< note >}} -Currently Calico is the only CNI plugin that the kubeadm project performs e2e tests against. +Kubeadm should be CNI agnostic and the validation of CNI providers is out of the scope of our current e2e testing. If you find an issue related to a CNI plugin you should log a ticket in its respective issue tracker instead of the kubeadm or kubernetes issue trackers. {{< /note >}} From 3ccdb3426ab8151b99c223f4c1e2fca61b1ba2fe Mon Sep 17 00:00:00 2001 From: Marc Bihlmaier <30314040+rdxmb@users.noreply.github.com> Date: Mon, 29 Mar 2021 15:00:45 +0200 Subject: [PATCH 056/104] Update kubelet-config-file.md (#27192) * Update kubelet-config-file.md add note and link to kubeadm/kubelet-integration * Update content/en/docs/tasks/administer-cluster/kubelet-config-file.md Co-authored-by: Qiming Teng Co-authored-by: Qiming Teng --- .../en/docs/tasks/administer-cluster/kubelet-config-file.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/content/en/docs/tasks/administer-cluster/kubelet-config-file.md b/content/en/docs/tasks/administer-cluster/kubelet-config-file.md index 54cd837370..252e140097 100644 --- a/content/en/docs/tasks/administer-cluster/kubelet-config-file.md +++ b/content/en/docs/tasks/administer-cluster/kubelet-config-file.md @@ -53,6 +53,11 @@ For a trick to generate a configuration file from a live node, see ## Start a Kubelet process configured via the config file +{{< note >}} +If you use kubeadm to initialize your cluster, use the kubelet-config while creating your cluster with `kubeadmin init`. +See [configuring kubelet using kubeadm](/docs/setup/production-environment/tools/kubeadm/kubelet-integration/) for details. +{{< /note >}} + Start the Kubelet with the `--config` flag set to the path of the Kubelet's config file. The Kubelet will then load its config from this file. @@ -80,4 +85,3 @@ is considered the default "last known good" configuration by the automatic rollb - From f6a5a55a5564c3fe16bcd06d2e9edc4f70d6038b Mon Sep 17 00:00:00 2001 From: carol valencia Date: Mon, 29 Mar 2021 09:29:08 -0300 Subject: [PATCH 057/104] chore: review fixing text - 3 --- content/es/docs/concepts/security/overview.md | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/content/es/docs/concepts/security/overview.md b/content/es/docs/concepts/security/overview.md index fdb3828cfe..f61b99c242 100644 --- a/content/es/docs/concepts/security/overview.md +++ b/content/es/docs/concepts/security/overview.md @@ -16,7 +16,7 @@ Este modelo de seguridad en el contenedor brinda sugerencias, no es una prueba d ## Las 4C de Seguridad en Cloud Native -Puede pensar en seguridad por capas. Las 4C de la seguridad en cloud Native son la nube(Cloud), +Puede pensar en seguridad por capas. Las 4C de la seguridad en Cloud Native son la nube(Cloud), Clústeres, Contenedores y Código. {{< note >}} @@ -30,13 +30,13 @@ Cada capa del modelo de seguridad Cloud Native es basada en la siguiente capa m La capa de código se beneficia de una base sólida(nube, clúster, contenedor) de capas seguras. No podemos garantizar la seguridad aplicando solo seguridad a nivel del código, y usar estándares de seguridad deficientes en las otras capas. -## Cloud +## Nube(Cloud) En muchos sentidos, la nube (o los servidores o el centro de datos corporativo) es la -[base informática confiable](https://en.wikipedia.org/wiki/Trusted_computing_base) +[base de computador confiable](https://es.wikipedia.org/wiki/Base_de_computador_confiable) de un clúster de Kubernetes. Si la capa de la nube es vulnerable (o configurado de alguna manera vulnerable), por consecuencia no hay garantía de que los componentes construidos -encima de la base sean seguras. Cada proveedor de la nube tiene recomendaciones de seguridad +encima de la base sean seguros. Cada proveedor de la nube tiene recomendaciones de seguridad para ejecutar las cargas de trabajo de forma segura en sus entornos. ### Seguridad del proveedor de la nube @@ -47,7 +47,7 @@ A continuación, algunos enlaces a la documentación de seguridad de los proveed {{< table caption="Cloud provider security" >}} -Provedor IaaS | Link | +Proveedor IaaS | Link | -------------------- | ------------ | Alibaba Cloud | https://www.alibabacloud.com/trust-center | Amazon Web Services | https://aws.amazon.com/security/ | @@ -66,15 +66,15 @@ Sugerencias para proteger su infraestructura en un clúster de Kubernetes: Área de Interés para la Infraestructura de Kubernetes | Recomendación | --------------------------------------------- | -------------- | -Acceso de red al servidor API (Plano de Control) | Todo acceso público al plano de control del Kubernetes en la Internet no está permitido y es controlado por listas de control de acceso a la red restrictas a un conjunto de direcciones IP necesarios para administrar el clúster.| -Acceso a la red de los Nodos | Los nodos deben ser configurados para _sólo_ aceptar conexiones (por medio de listas de control de acceso a la red) desde el plano de control en los puertos especificados y aceptar conexiones para servicios en Kubernetes del tipo NodePort y LoadBalancer. Si es posible, estos nodos no deben exponerse públicamente en la Internet. -Acceso de la API del Kubernetes al proveedor de la Cloud | Cada proveedor de la nube debe dar un conjunto de permisos al plano de control y nodos del Kubernetes. Es mejor otorgar al clúster el permiso de acceso al proveedor de nube siguiendo el [principio del mínimo privilegio](https://en.wikipedia.org/wiki/Principle_of_least_privilege) para los recursos que necesite administrar. La [documentación del Kops](https://github.com/kubernetes/kops/blob/master/docs/iam_roles.md#iam-roles) fornece informações sobre as políticas e roles do IAM. -Acceso al etcd | El acceso al etcd (banco de dados do Kubernetes) debe ser limitado apenas al plano de control. Dependiendo de su configuración, debería intentar usar etcd sobre TLS. Mayores informaciones pueden ser encontradas en la [documentación del etcd](https://github.com/etcd-io/etcd/tree/master/Documentation). -Encriptación etcd | Siempre que sea posible, es una buena práctica encriptar todas las unidades de almacenamiento, el etcd mantiene el estado de todo el clúster (incluidos los Secretos), su disco debe estar encriptado. +Acceso de red al servidor API (Plano de Control) | Todo acceso público al plano de control del Kubernetes en Internet no está permitido y es controlado por listas de control de acceso a la red estrictas a un conjunto de direcciones IP necesarias para administrar el clúster.| +Acceso a la red de los Nodos | Los nodos deben ser configurados para _sólo_ aceptar conexiones (por medio de listas de control de acceso a la red) desde el plano de control en los puertos especificados y aceptar conexiones para servicios en Kubernetes del tipo NodePort y LoadBalancer. Si es posible, estos nodos no deben exponerse públicamente en Internet. +Acceso a la API de Kubernetes del proveedor de la nube | Cada proveedor de la nube debe dar un conjunto de permisos al plano de control y nodos del Kubernetes. Es mejor otorgar al clúster el permiso de acceso al proveedor de nube siguiendo el [principio de mínimo privilegio](https://es.wikipedia.org/wiki/Principio_de_m%C3%ADnimo_privilegio) para los recursos que necesite administrar. La [documentación del Kops](https://github.com/kubernetes/kops/blob/master/docs/iam_roles.md#iam-roles) ofrece información sobre las políticas y roles de IAM. +Acceso a etcd | El acceso a etcd (banco de datos de Kubernetes) debe ser limitado apenas al plano de control. Dependiendo de su configuración, debería intentar usar etcd sobre TLS. Puede encontrar mas información en la [documentación de etcd](https://github.com/etcd-io/etcd/tree/master/Documentation). +Encriptación etcd | Siempre que sea posible, es una buena práctica encriptar todas las unidades de almacenamiento, etcd mantiene el estado de todo el clúster (incluidos los Secretos), su disco debe estar encriptado. {{< /table >}} -## Cluster +## Clúster Existe dos áreas de preocupación para proteger Kubernetes: From 7f66bfd0595ff77a0db12a69a039d2ed2657ef8b Mon Sep 17 00:00:00 2001 From: Ricardo Pchevuzinske Katz Date: Mon, 29 Mar 2021 18:25:04 -0300 Subject: [PATCH 058/104] Add pt translation for extend networking --- .../compute-storage-net/_index.md | 4 + .../compute-storage-net/network-plugins.md | 209 ++++++++++++++++++ 2 files changed, 213 insertions(+) create mode 100644 content/pt/docs/concepts/extend-kubernetes/compute-storage-net/_index.md create mode 100644 content/pt/docs/concepts/extend-kubernetes/compute-storage-net/network-plugins.md diff --git a/content/pt/docs/concepts/extend-kubernetes/compute-storage-net/_index.md b/content/pt/docs/concepts/extend-kubernetes/compute-storage-net/_index.md new file mode 100644 index 0000000000..6b6090a666 --- /dev/null +++ b/content/pt/docs/concepts/extend-kubernetes/compute-storage-net/_index.md @@ -0,0 +1,4 @@ +--- +title: Extensões de Computação, armazenamento e redes +weight: 30 +--- diff --git a/content/pt/docs/concepts/extend-kubernetes/compute-storage-net/network-plugins.md b/content/pt/docs/concepts/extend-kubernetes/compute-storage-net/network-plugins.md new file mode 100644 index 0000000000..3d61ab72cc --- /dev/null +++ b/content/pt/docs/concepts/extend-kubernetes/compute-storage-net/network-plugins.md @@ -0,0 +1,209 @@ +--- +title: Plugins de rede +content_type: concept +weight: 10 +--- + + + +Plugins de redes no Kubernetes podem ser dos seguintes tipos: + +* Plugins CNI: Aderentes à especificação [Container Network Interface](https://github.com/containernetworking/cni) (CNI), desenhados para interoperabilidade. + * Kubernetes usa a versão [v0.4.0](https://github.com/containernetworking/cni/blob/spec-v0.4.0/SPEC.md) da especificação CNI. +* Plugin kubenet: Implementa o `cbr0` básico usando os plugins CNI `bridge` e `host-local` + + + +## Instalação + +O kubelet possui um plugin único padrão, e um plugin padrão comum para todo o cluster. +Ele verifica o plugin quando inicia, se lembra o que encontrou, e executa o plugin selecionado +em momentos oportunos dentro do ciclo de vida de um Pod (isso é verdadeiro apenas com o Docker, +uma vez que o CRI gerencia seus próprios plugins de CNI). Existem dois parâmetros de linha de comando +no Kubelet para se ter em mente quando usando plugins: + +* `cni-bin-dir`: O Kubelet verifica esse diretório por plugins na inicialização +* `network-plugin`: O plugin de rede que deve ser utilizado do diretório configurado em +`cni-bin-dir`. Deve ser igual ao nome configurado por um plugin no diretório de plugins. +Para plugins de CNI, isso equivale ao valor `cni`. + +## Requisitos de plugins de Rede + +Além de prover a [interface `NetworkPlugin`](https://github.com/kubernetes/kubernetes/tree/{{< param "fullversion" >}}/pkg/kubelet/dockershim/network/plugins.go) +para configuração da rede do pod, o plugin pode necessitar de suporte específico ao +kube-proxy. +O proxy iptables obviamente depende do iptables, e o plugin deve garantir que o +tráfego do contêiner esteja disponível para o iptables. Por exemplo, se o plugin +conecta os contêineres à _Linux bridge_, o plugin deve configurar a diretiva de +_sysctl_ `net/bridge/bridge-nf-call-iptables` com o valor `1` para garantir que o +proxy iptables opere normalmente. Se o plugin não faz uso da _Linux Bridge_ (mas outro +mecanismo, como Open vSwitch) ele deve garantir que o tráfego do contêiner é roteado +apropriadamente para o proxy. + +Por padrão, se nenhum plugin de rede é configurado no kubelet, o plugin `noop` é utilizado, +que configura `net/bridge/bridge-nf-call-iptables=1` para garantir que configurações simples +(como Docker com _bridge Linux_) operem corretamente com o proxy iptables. + +### CNI + +O plugin de CNI é selecionado utilizando-se da opção `--network-plugin=cni` no início do Kubeket. +O Kubelet lê um arquivo do diretório especificado em `--cni-conf-dir` (padrão `/etc/cni/net.d`) +e usa a configuração de CNI desse arquivo para configurar a rede de cada Pod. O arquivo de +configuração do CNI deve usar a [especificação de CNI](https://github.com/containernetworking/cni/blob/master/SPEC.md#network-configuration), +e qualquer plugin referenciado nesse arquivo deve estar presente no diretório +`--cni-bin-dir` (padrão `/opt/cni/bin`). + +Se existirem múltiplos arquivos de configuração no diretório, o kubelet usa o arquivo de +configuração que vier primeiro pelo nome, em ordem alfabética. + +Adicionalmente ao plugin de CNI especificado no arquivo de configuração, o Kubernetes requer +o plugin CNI padrão [`lo`](https://github.com/containernetworking/plugins/blob/master/plugins/main/loopback/loopback.go) ao menos na versão 0.2.0. + +#### Suporte a hostPort + +O plugin de redes CNI suporta `hostPort`. Você pode utilizar o plugin oficial +[portmap](https://github.com/containernetworking/plugins/tree/master/plugins/meta/portmap) +ou usar seu próprio plugin com a funcionalidade de _portMapping_. + +Caso você deseje habilitar o suporte a `hostPort`, você deve especificar +`portMappings capability` no seu `cni-conf-dir`. +Por exemplo: + +```json +{ + "name": "k8s-pod-network", + "cniVersion": "0.3.0", + "plugins": [ + { + "type": "calico", + "log_level": "info", + "datastore_type": "kubernetes", + "nodename": "127.0.0.1", + "ipam": { + "type": "host-local", + "subnet": "usePodCidr" + }, + "policy": { + "type": "k8s" + }, + "kubernetes": { + "kubeconfig": "/etc/cni/net.d/calico-kubeconfig" + } + }, + { + "type": "portmap", + "capabilities": {"portMappings": true} + } + ] +} +``` + +#### Suporte a controle de banda + +**Funcionalidade experimental** + +O plugin de rede CNI também suporta o controle de banda de entrada e saída. +Você pode utilizar o plugin oficial [bandwidth](https://github.com/containernetworking/plugins/tree/master/plugins/meta/bandwidth) +desenvolvido ou usar seu próprio plugin de controle de banda. + +Se você habilitar o suporte ao controle de banda, você deve adicionar o plugin `bandwidth` +no seu arquivo de configuração de CNI (padrão `/etc/cni/net.d`) e garantir que o programa +exista no diretório de binários do CNI (padrão `/opt/cni/bin`). + +```json +{ + "name": "k8s-pod-network", + "cniVersion": "0.3.0", + "plugins": [ + { + "type": "calico", + "log_level": "info", + "datastore_type": "kubernetes", + "nodename": "127.0.0.1", + "ipam": { + "type": "host-local", + "subnet": "usePodCidr" + }, + "policy": { + "type": "k8s" + }, + "kubernetes": { + "kubeconfig": "/etc/cni/net.d/calico-kubeconfig" + } + }, + { + "type": "bandwidth", + "capabilities": {"bandwidth": true} + } + ] +} +``` + +Agora você pode adicionar as anotações `kubernetes.io/ingress-bandwidth` e +`kubernetes.io/egress-bandwidth` em seu pod. +Por exemplo: + +```yaml +apiVersion: v1 +kind: Pod +metadata: + annotations: + kubernetes.io/ingress-bandwidth: 1M + kubernetes.io/egress-bandwidth: 1M +... +``` + +### kubenet + +Kubenet é um plugin de rede muito simples, existente apenas no Linux. Ele não +implementa funcionalidades mais avançadas, como rede entre nós ou políticas de rede. +Ele é geralmente utilizado junto a um provedor de nuvem que configura as regras de +roteamento para comunicação entre os nós, ou em ambientes com apenas um nó. + +O Kubenet cria uma _interface bridge_ no Linux chamada `cbr0` e cria um par _veth_ +para cada um dos pods com o host como a outra ponta desse par, conectado à `cbr0`. +Na interface no lado do Pod um endereço IP é alocado de uma faixa associada ao nó, +sendo parte de alguma configuração no nó ou pelo controller-manager. Na interface `cbr0` +é associado o MTU equivalente ao menor MTU de uma interface de rede do host. + +Esse plugin possui alguns requisitos: + +* Os plugins CNI padrão `bridge`, `lo` e `host-local` são obrigatórios, ao menos na +versão 0.2.0. O Kubenet buscará inicialmente esses plugins no diretório `/opt/cni/bin`. +Especifique a opção `cni-bin-dir` no kubelet para fornecer um diretório adicional +de busca. O primeiro local equivalente será o utilizado. +* O kubelet deve ser executado com a opção `--network-plugin=kubenet` para habilitar esse plugin. +* O Kubelet deve ainda ser executado com a opção `--non-masquerade-cidr=` para +garantir que o tráfego de IPs para fora dessa faixa seja mascarado. +* O nó deve possuir uma subrede associada, através da opção `--pod-cidr` configurada +na inicialização do kubelet, ou as opções `--allocate-node-cidrs=true --cluster-cidr=` +utilizadas na inicialização do _controller-manager_. + +### Customizando o MTU (com kubenet) + +O MTU deve sempre ser configurado corretamente para obter-se a melhor performance de +rede. Os plugins de rede geralmente tentam detectar uma configuração correta de MTU, +porém algumas vezes a lógica não irá resultar em uma configuração adequada. Por exemplo, +se a _Docker bridge_ ou alguma outra interface possuir um MTU pequeno, o kubenet irá +selecionar aquela MTU. Ou caso você esteja utilizando encapsulamento IPSEC, o MTU deve +ser reduzido, e esse cálculo não faz parte do escopo da maioria dos plugins de rede. + +Sempre que necessário, você pode configurar explicitamente o MTU com a opção `network-plugin-mtu` +no kubelet. Por exemplo, na AWS o MTU da `eth0` geralmente é 9001 então você deve +especificar `--network-plugin-mtu=9001`. Se você estiver usando IPSEC você deve reduzir +o MTU para permitir o encapsulamento excedente; por exemplo: `--network-plugin-mtu=8773`. + +Essa opção faz parte do plugin de rede. Atualmente **apenas o kubenet suporta a configuração +`network-plugin-mtu`**. + +## Resumo de uso + +* `--network-plugin=cni` especifica que devemos usar o plugin de redes `cni` com os +binários do plugin localizados em `--cni-bin-dir` (padrão `/opt/cni/bin`) e as +configurações do plugin localizadas em `--cni-conf-dir` (default `/etc/cni/net.d`). +* `--network-plugin=kubenet` especifica que iremos usar o plugin de rede `kubenet` +com os plugins CNI `bridge`, `lo` e `host-local` localizados em `/opt/cni/bin` ou `cni-bin-dir`. +* `--network-plugin-mtu=9001` especifica o MTU a ser utilizado, atualmente apenas em uso +pelo plugin de rede `kubenet` + +## {{% heading "whatsnext" %}} From 66206ab1415fc76e03371aa434e3b8537ba41eac Mon Sep 17 00:00:00 2001 From: Arhell Date: Tue, 30 Mar 2021 00:38:49 +0300 Subject: [PATCH 059/104] [zh] fix: errors in base64 and sed commands --- .../tls/manual-rotation-of-ca-certificates.md | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/content/zh/docs/tasks/tls/manual-rotation-of-ca-certificates.md b/content/zh/docs/tasks/tls/manual-rotation-of-ca-certificates.md index ca9601eeb3..87e9b5eb64 100644 --- a/content/zh/docs/tasks/tls/manual-rotation-of-ca-certificates.md +++ b/content/zh/docs/tasks/tls/manual-rotation-of-ca-certificates.md @@ -98,12 +98,12 @@ Configurations with a single API server will experience unavailability while the 也会获得此更新并且同时信任老的和新的 CA 证书。 ```shell - base64_encoded_ca="$(base64 )" + base64_encoded_ca="$(base64 -w0 )" for namespace in $(kubectl get ns --no-headers | awk '{print $1}'); do for token in $(kubectl get secrets --namespace "$namespace" --field-selector type=kubernetes.io/service-account-token -o name); do kubectl get $token --namespace "$namespace" -o yaml | \ - /bin/sed "s/\(ca.crt:\).*/\1 ${base64_encoded_ca}" | \ + /bin/sed "s/\(ca.crt:\).*/\1 ${base64_encoded_ca}/" | \ kubectl apply -f - done done @@ -205,13 +205,13 @@ Configurations with a single API server will experience unavailability while the {{< note >}} 要使用 `openssl` 命令行为集群生成新的证书和私钥,可参阅 - [证书(`openssl`)](/zh/docs/concepts/cluster-administration/certificates/#openssl)。 - 你也可以使用[`cfssl`](/zh/docs/concepts/cluster-administration/certificates/#cfssl). + [证书(`openssl`)](/zh/docs/tasks/administer-cluster/certificates/#openssl)。 + 你也可以使用[`cfssl`](/zh/docs/tasks/administer-cluster/certificates/#cfssl). {{< /note >}} ### 启用由云服务驱动支持的 KMS -有关启用云服务驱动特定的 KMS 插件的说明,请咨询你的云服务驱动。 +有关启用云服务驱动特定的 KMS 插件的说明,请咨询你的云服务驱动商。 Kubernetes Pods 有[确定的生命周期](/zh/docs/concepts/workloads/pods/pod-lifecycle/)。 -例如,当某 Pod 在你的集群中运行,Pod 运行所在的 +例如,当某 Pod 在你的集群中运行时,Pod 运行所在的 {{< glossary_tooltip text="节点" term_id="node" >}} 出现致命错误时, 所有该节点上的 Pods 都会失败。Kubernetes 将这类失败视为最终状态: 即使该节点后来恢复正常运行,你也需要创建新的 Pod 来恢复应用。 @@ -172,4 +172,3 @@ using an [`Ingress`](/docs/concepts/services-networking/ingress). [`Service`](/zh/docs/concepts/services-networking/service/) 的形式使之可在互联网上访问;或者对于 Web 应用而言,使用 [`Ingress`](/zh/docs/concepts/services-networking/ingress) 资源将其暴露到互联网上。 - From 68032faaccbbcf23870e941924cae22fc85c203f Mon Sep 17 00:00:00 2001 From: KLH Date: Tue, 30 Mar 2021 11:57:56 +0800 Subject: [PATCH 062/104] [zh] modify: zh/docs/concepts/workloads/_index.md (#27308) * fix a word translation * Update content/zh/docs/concepts/workloads/_index.md Co-authored-by: Qiming Teng Co-authored-by: Qiming Teng --- content/zh/docs/concepts/workloads/_index.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/content/zh/docs/concepts/workloads/_index.md b/content/zh/docs/concepts/workloads/_index.md index 743d452d99..a61176f660 100644 --- a/content/zh/docs/concepts/workloads/_index.md +++ b/content/zh/docs/concepts/workloads/_index.md @@ -38,7 +38,7 @@ all the pods on that node fail. Kubernetes treats that level of failure as final would need to create a new `Pod` to recover, even if the node later becomes healthy. --> Kubernetes Pods 有[确定的生命周期](/zh/docs/concepts/workloads/pods/pod-lifecycle/)。 -例如,一旦某 Pod 在你的集群中运行,Pod 运行所在的 +例如,当某 Pod 在你的集群中运行时,Pod 运行所在的 {{< glossary_tooltip text="节点" term_id="node" >}} 出现致命错误时, 所有该节点上的 Pods 都会失败。Kubernetes 将这类失败视为最终状态: 即使该节点后来恢复正常运行,你也需要创建新的 Pod 来恢复应用。 @@ -172,4 +172,3 @@ using an [`Ingress`](/docs/concepts/services-networking/ingress). [`Service`](/zh/docs/concepts/services-networking/service/) 的形式使之可在互联网上访问;或者对于 Web 应用而言,使用 [`Ingress`](/zh/docs/concepts/services-networking/ingress) 资源将其暴露到互联网上。 - From cbff017b691c6f1bc4bffa3775c2d22009c3ecfb Mon Sep 17 00:00:00 2001 From: konglinghang Date: Tue, 30 Mar 2021 14:14:36 +0800 Subject: [PATCH 063/104] fix a word translation --- content/zh/docs/concepts/workloads/pods/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/zh/docs/concepts/workloads/pods/_index.md b/content/zh/docs/concepts/workloads/pods/_index.md index 57b933b9e8..422ee139c2 100644 --- a/content/zh/docs/concepts/workloads/pods/_index.md +++ b/content/zh/docs/concepts/workloads/pods/_index.md @@ -54,7 +54,7 @@ for debugging if your cluster offers this. 除了应用容器,Pod 还可以包含在 Pod 启动期间运行的 [Init 容器](/zh/docs/concepts/workloads/pods/init-containers/)。 你也可以在集群中支持[临时性容器](/zh/docs/concepts/workloads/pods/ephemeral-containers/) -的情况外,为调试的目的注入临时性容器。 +的情况下,为调试的目的注入临时性容器。 From 8995eaa2484277e269382487fbf1fc416118c431 Mon Sep 17 00:00:00 2001 From: GoodGameZoo Date: Tue, 30 Mar 2021 00:18:42 -0700 Subject: [PATCH 064/104] Correct typo in page create-cluster-kubeadm.md --- .../tools/kubeadm/create-cluster-kubeadm.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/zh/docs/setup/production-environment/tools/kubeadm/create-cluster-kubeadm.md b/content/zh/docs/setup/production-environment/tools/kubeadm/create-cluster-kubeadm.md index c6619d0034..eabdd1bc1f 100644 --- a/content/zh/docs/setup/production-environment/tools/kubeadm/create-cluster-kubeadm.md +++ b/content/zh/docs/setup/production-environment/tools/kubeadm/create-cluster-kubeadm.md @@ -128,7 +128,7 @@ Any commands under `kubeadm alpha` are, by definition, supported on an alpha lev -### 在你的主机上安装安装 kubeadm +### 在你的主机上安装 kubeadm -### 加入 Windows 工作节点 {joining-a-windows-worker-node} +### 加入 Windows 工作节点 {#joining-a-windows-worker-node} 你必须安装 `Containers` 功能特性并安装 Docker 工具。相关的指令可以在 [Install Docker Engine - Enterprise on Windows Servers](https://hub.docker.com/editions/enterprise/docker-ee-server-windows) From d39d4b4bf7100d3510dae5d365077d2a4fa7d818 Mon Sep 17 00:00:00 2001 From: Shubham Kuchhal Date: Tue, 30 Mar 2021 17:03:10 +0530 Subject: [PATCH 066/104] Corrected the description in 'Restrict a Container's Access to Resources with AppArmor' --- content/en/docs/tutorials/clusters/apparmor.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/tutorials/clusters/apparmor.md b/content/en/docs/tutorials/clusters/apparmor.md index b220647e62..32f25ba483 100644 --- a/content/en/docs/tutorials/clusters/apparmor.md +++ b/content/en/docs/tutorials/clusters/apparmor.md @@ -322,7 +322,7 @@ Events: 23s 23s 1 {kubelet e2e-test-stclair-node-pool-t1f5} Warning AppArmor Cannot enforce AppArmor: profile "k8s-apparmor-example-allow-write" is not loaded ``` -Note the pod status is Failed, with a helpful error message: `Pod Cannot enforce AppArmor: profile +Note the pod status is Pending, with a helpful error message: `Pod Cannot enforce AppArmor: profile "k8s-apparmor-example-allow-write" is not loaded`. An event was also recorded with the same message. ## Administration From f3e31e4ce9f3170fc03cd73ce18cf2ddc966e37b Mon Sep 17 00:00:00 2001 From: GoodGameZoo Date: Tue, 30 Mar 2021 06:36:33 -0700 Subject: [PATCH 067/104] Correct translation connect-applications-service.md --- .../connect-applications-service.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/content/zh/docs/concepts/services-networking/connect-applications-service.md b/content/zh/docs/concepts/services-networking/connect-applications-service.md index 2476d56f73..e75422a41b 100644 --- a/content/zh/docs/concepts/services-networking/connect-applications-service.md +++ b/content/zh/docs/concepts/services-networking/connect-applications-service.md @@ -44,8 +44,8 @@ Create an nginx Pod, and note that it has a container port specification: --> ## 在集群中暴露 Pod -我们在之前的示例中已经做过,然而再让我重试一次,这次聚焦在网络连接的视角。 -创建一个 Nginx Pod,指示它具有一个容器端口的说明: +我们在之前的示例中已经做过,然而让我们以网络连接的视角再重做一遍。 +创建一个 Nginx Pod,并且注意,它有一个容器端口的规范: {{< codenew file="service/networking/run-my-nginx.yaml" >}} @@ -314,9 +314,9 @@ The rest of this section will assume you have a Service with a long lived IP 本段剩余的内容,将假设已经有一个 Service,它具有一个长久存在的 IP(my-nginx), 一个为该 IP 指派名称的 DNS 服务器。 这里我们使用 CoreDNS 集群插件(应用名为 `kube-dns`), 所以可以通过标准做法,使在集群中的任何 Pod 都能与该 Service 通信(例如:`gethostbyname()`)。 -如果 CoreDNS 没有在运行,你可以参照 -[CoreDNS README](https://github.com/coredns/deployment/tree/master/kubernetes) 或者 -[安装 CoreDNS](/zh/docs/tasks/administer-cluster/coredns/#installing-coredns) 来启用它。 +如果 CoreDNS 没有在运行,你可以参照 +[CoreDNS README](https://github.com/coredns/deployment/tree/master/kubernetes) 或者 +[安装 CoreDNS](/zh/docs/tasks/administer-cluster/coredns/#installing-coredns) 来启用它。 让我们运行另一个 curl 应用来进行测试: ```shell From 33a84d66df8ab26f9634e8ec5e40e7c1ec212be5 Mon Sep 17 00:00:00 2001 From: Jose Roberto Almaraz Date: Wed, 31 Mar 2021 00:51:58 +1100 Subject: [PATCH 068/104] Add content/pt/docs/reference/access-authn-authz/authentication.md (#26928) * Add content/pt/docs/reference/access-authn-authz/authentication.md * fixing markdown links * wrong reference for adding bearer token to request * wrong reference for adding bearer token to request - reviewed * addressing review items from rikatz * addressing review items: typos, wrong reference link for webhook authentication, etc * fixing typos, adding placeholders for glossary terms * Fixing glossary reference and adding glossary content * 2 more reviewed items * plural for transparentes * fixing wrong glossary term_id for common-name, using tls-common-name instead * fixing webhook and proxy authentication links * fixing wrong gramatic on groups description * review items on multiple syntax and context/meaning errors --- .../access-authn-authz/authentication.md | 888 ++++++++++++++++++ .../glossary/alternate-x509-schemes.md | 27 + .../pt/docs/reference/glossary/kerberos.md | 27 + .../pt/docs/reference/glossary/keystone.md | 16 + content/pt/docs/reference/glossary/ldap.md | 28 + content/pt/docs/reference/glossary/saml.md | 36 + .../reference/glossary/tls-common-name.md | 18 + content/pt/docs/reference/glossary/uid.md | 13 + .../pt/docs/reference/glossary/username.md | 16 + 9 files changed, 1069 insertions(+) create mode 100644 content/pt/docs/reference/access-authn-authz/authentication.md create mode 100644 content/pt/docs/reference/glossary/alternate-x509-schemes.md create mode 100644 content/pt/docs/reference/glossary/kerberos.md create mode 100644 content/pt/docs/reference/glossary/keystone.md create mode 100644 content/pt/docs/reference/glossary/ldap.md create mode 100644 content/pt/docs/reference/glossary/saml.md create mode 100644 content/pt/docs/reference/glossary/tls-common-name.md create mode 100644 content/pt/docs/reference/glossary/uid.md create mode 100644 content/pt/docs/reference/glossary/username.md diff --git a/content/pt/docs/reference/access-authn-authz/authentication.md b/content/pt/docs/reference/access-authn-authz/authentication.md new file mode 100644 index 0000000000..7882b4974d --- /dev/null +++ b/content/pt/docs/reference/access-authn-authz/authentication.md @@ -0,0 +1,888 @@ +--- +title: Autenticação +content_type: concept +weight: 10 +--- + + +Essa página demonstra uma visão geral sobre autenticação + + +## Usuários no Kubernetes + +Todos os clusters Kubernetes possuem duas categorias de usuários: contas de serviço gerenciadas pelo Kubernetes e usuários normais. + +Assume-se que um serviço independente do cluster gerencia usuários normais das seguintes formas: + +- Um administrador distribuindo chaves privadas +- Uma base de usuários como Keystone {{< glossary_definition term_id="keystone" length="all" >}} ou Google Accounts +- Um arquivo com uma lista de nomes de usuários e senhas + +Neste quesito, _Kubernetes não possui objetos que possam representar as contas de um usuário normal._ Usuários normais não podem ser adicionados ao _cluster_ através de uma chamada para a API. + +Apesar de um usuário normal não poder ser adicionado através de uma chamada para a API, qualquer usuário que apresente um certificado válido e assinado pela autoridade de certificados (CA) do _cluster_ é considerado autenticado. Nesta configuração, Kubernetes determina o nome do usuário baseado no campo de nome comum no sujeito (_subject_) do certificado (por exemplo: "/CN=bob"). A partir daí, o subsistema de controle de acesso baseado em função (RBAC) determina se o usuário é autorizado a realizar uma operação específica sobre o recurso. Para mais detalhes, veja a referência sobre o tópico de usuários normais dentro de [requisição de certificado](/docs/reference/access-authn-authz/certificate-signing-requests/#normal-user). + +Em contraste a usuários normais, contas de serviço são considerados usuários gerenciados pela API do Kubernetes. Elas estão vinculadas à _namespaces_ específicas e criadas automaticamente pelo servidor de API ou manualmente através de chamadas da API. Contas de serviço estão ligadas a um conjunto de credenciais armazenados como `Secrets`, aos quais são montados dentro dos _pods_ assim permitindo que processos internos ao _cluster_ comuniquem-se com a API do Kubernetes. + +Requisições para a API estão ligadas a um usuário normal, conta de serviço ou serão tratadas como [requisições anônimas](#anonymous-requests). Isto significa que cada processo dentro ou fora do _cluster_, desde um usuário humano utilizando o `kubectl` de uma estação de trabalho, a `kubelets` rodando nos nós, a membros da camada de gerenciamento (s/painel de controle) devem autenticar-se ao realizarem suas requisições para o servidor API ou serão tratados como usuário anônimo. + +## Estratégias de autenticação + +Kubernetes usa certificados de clientes, _bearer Token_, um proxy realizando autenticação, ou uma autenticação básica HTTP para autenticar requisições para o servidor de API através de plugins. Como requisições HTTP são feitas no servidor de API, plugins tentam associar os seguintes atributos junto a requisição: + +* Username {{< glossary_definition term_id="username" length="all" >}}: um valor (String) que identifica o usuário final. Valores comuns podem ser `kube-admin` ou `jane@example.com` +* UID {{< glossary_definition term_id="uid" length="all" >}}: um valor (String) que identifica o usuário final e tenta ser mais consistente e único do que username. +* Groups: Um conjunto de valores em que cada item indica a associação de um usuário à uma coleção lógica de usuários. Valores comuns podem ser `system:masters` ou `devops-team`. +* Campos extras: um mapa que pode conter uma lista de atributos que armazena informações adicionais em que autorizadores podem achar útil. + +Todos os valores são transparentes para o sistema de autenticação e somente trazem significado quando interpretados por um [autorizador](/docs/reference/access-authn-authz/authorization/). + +É possível habilitar múltiplos métodos de autenticação. Deve-se normalmente usar pelo menos dois métodos: + +- _Tokens_ para contas de serviço; +- Pelo menos um outro método de autenticação para usuários. + +Quando múltiplos módulos de autenticação estão habilitados, o primeiro módulo a autenticar com sucesso uma requisição termina, o fluxo de avaliação da mesma. + +O servidor de API não garante a ordem em que os autenticadores são processados. + +O grupo `system:authenticated` é incluído na lista de grupos de todos os usuários autenticados. + +Integrações com outros protocolos de autenticação, como LDAP {{< glossary_definition term_id="ldap" length="all" >}}, SAML {{< glossary_definition term_id="saml" length="all" >}}, Kerberos {{< glossary_definition term_id="kerberos" length="all" >}}, alternate x509 schemes {{< glossary_definition term_id="alternate-x509-schemes" length="all" >}}, etc, podem ser alcançadas utilizando-se de um [proxy](#autenticando-com-proxy) ou [webhook](#token-de-autenticação-via-webhook) de autenticação. + +### Certificados de cliente X509 + +Autenticação via certificados de cliente pode ser habilitada ao passar a opção `--client-ca-file=ARQUIVO` para o servidor de API. O arquivo referenciado deve conter um ou mais autoridades de certificação usadas para validar o certificado de cliente passado para o servidor de API. Se o certificado de cliente é apresentado e verificado, o _common name_ {{< glossary_definition term_id="tls-common-name" length="all" >}} do sujeito é usado como o nome de usuário para a requisição. A partir da versão 1.4, certificados de cliente podem também indicar o pertencimento de um usuário a um grupo utilizando o campo de organização do certificado. Para incluir múltiplos grupos para o usuário, deve-se incluir múltiplos campos de organização no certificado. + +Por exemplo, utilizando o comando de linha `openssl` para gerar uma requisição de assinatura de certificado: + +``` bash +openssl req -new -key jbeda.pem -out jbeda-csr.pem -subj "/CN=jbeda/O=app1/O=app2" +``` + +Isto criaria um arquivo de tipo CSR (requisição de assinatura de certificado) para o usuário "jbeda" pertencendo a dois grupos: "app1" e "app2". + +Veja como gerar um certificado de cliente em [Gerenciando Certificados](/docs/concepts/cluster-administration/certificates/) + +### Arquivo estático de Token + +O servidor de API lê _bearer tokens_ de um arquivo quando recebe uma requisição contendo a opção `--token-auth-file=ARQUIVO` via linha de comando. Atualmente, tokens têm duração indefinida, e a lista de tokens não pode ser modificada sem reiniciar o servidor de API. + +O arquivo de token é do tipo CSV contendo no mínimo 3 colunas: token, nome de usuário, identificador de usuário (uid), seguido pelos nomes de grupos (opcional). + +{{< note >}} +Se uma entrada possuir mais de um grupo, a coluna deve ser cercada por aspas duplas, por exemplo: + +```conf +token,usuario,uid,"grupo1,grupo2,grupo3" +``` +{{< /note >}} + +#### Adicionando um _bearer token_ em uma requisição + +Quando utilizando-se de _bearer token_ para autenticação de um cliente HTTP, o servidor de API espera um cabeçalho `Authorization` com um valor `Bearer TOKEN`. O token deve ser uma sequência de caracteres que pode ser colocada como valor em um cabeçalho HTTP não utilizando-se mais do que as facilidades de codificação e citação de HTTP. Por exemplo, se o valor de um token é `31ada4fd-adec-460c-809a-9e56ceb75269` então iria aparecer dentro de um cabeçalho HTTP como: + +```http +Authorization: Bearer 31ada4fd-adec-460c-809a-9e56ceb75269 +``` +### Tokens de inicialização + +{{< feature-state for_k8s_version="v1.18" state="stable" >}} + +Para permitir a inicialização simplificada para novos _clusters_, Kubernetes inclui um token dinamicamente gerenciado denominado *Bootstrap Token*. Estes _tokens_ são armazenados como Secrets dentro do namespace `kube-system`, onde eles podem ser dinamicamente criados e gerenciados. O componente Gerenciador de Controle (Controller Manager) possui um controlador "TokenCleaner" que apaga os _tokens_ de inicialização expirados. + +Os _tokens_ seguem o formato `[a-z0-9]{6}.[a-z0-9]{16}`. O primeiro componente é um identificador do _token_ e o segundo é o segredo. Você pode especificar o _token_ como um cabeçalho HTTP como: + +```http +Authorization: Bearer 781292.db7bc3a58fc5f07e +``` + +Deve-se habilitar os _tokens_ de inicialização com a opção `--enable-bootstrap-token-auth` no servidor de API. Deve-se habilitar o controlador `TokenCleaner` através da opção `--controllers` no Gerenciador de Controle. Isso é feito, por exemplo, como: `--controllers=*,tokencleaner`. O `kubeadm`, por exemplo, irá realizar isso caso seja utilizado para a inicialização do cluster. + +O autenticador o autentica como `system:bootstrap:` e é incluído no grupo `system:bootstrappers`. O nome e grupo são intencionalmente limitados para desencorajar usuários a usarem estes _tokens_ após inicialização. Os nomes de usuários e grupos podem ser utilizados (e são utilizados pelo `kubeadm`) para elaborar as políticas de autorização para suportar a inicialização de um cluster. + +Por favor veja [Bootstrap Tokens](/docs/reference/access-authn-authz/bootstrap-tokens/) para documentação detalhada sobre o autenticador e controladores de _Token_ de inicialização, bem como gerenciar estes _tokens_ com `kubeadm`. + +### Tokens de Contas de serviço + +Uma conta de serviço é um autenticador habilitado automaticamente que usa bearer tokens para verificar as requisições. O plugin aceita dois parâmetros opcionais: + +* `--service-account-key-file` Um arquivo contendo uma chave codificada no formato PEM para assinar _bearer tokens_. Se não especificado, a chave privada de TLS no servidor de API será utilizada +* `--service-account-lookup` Se habilitado, _tokens_ deletados do servidor de API serão revogados. + +Contas de serviço são normalmente criadas automaticamente pelo servidor de API e associada a _pods_ rodando no cluster através do controlador de admissão [Admission Controller](/docs/reference/access-authn-authz/admission-controllers/) de `ServiceAccount`. Os tokens de contas de serviços são montados nos Pods, em localizações já pré definidas e conhecidas e permitem processos dentro do cluster a se comunicarem com o servidor de API. Contas podem ser explicitamente associadas com _pods_ utilizando o campo `serviceAccountName` na especificação do pod (`PodSpec`): + +{{< note >}} +`serviceAccountName` é normalmente omitida por ser feito automaticamente +{{< /note >}} + +```yaml +apiVersion: apps/v1 +kind: Deployment +metadata: + name: nginx-deployment + namespace: default +spec: + replicas: 3 + template: + metadata: + # ... + spec: + serviceAccountName: bob-the-bot + containers: + - name: nginx + image: nginx:1.14.2 +``` + +Os _tokens_ de contas de serviço são perfeitamente válidos para ser usados fora do cluster e podem ser utilizados para criar identidades para processos de longa duração que desejem comunicar-se com a API do Kubernetes. Para criar manualmente uma conta de serviço, utilize-se simplesmente o comando `kubectl create serviceaccount (NOME)`. Isso cria uma conta de serviço e um segredo associado a ela no namespace atual. + +```bash +kubectl create serviceaccount jenkins +``` + +```none +serviceaccount "jenkins" created +``` + +Verificando um segredo associado: + +```bash +kubectl get serviceaccounts jenkins -o yaml +``` + +```yaml +apiVersion: v1 +kind: ServiceAccount +metadata: + # ... +secrets: +- name: jenkins-token-1yvwg +``` +O segredo criado irá armazenar a autoridade de certificado do servidor de API e um JSON Web Token (JWT) digitalmente assinado. + +```bash +kubectl get secret jenkins-token-1yvwg -o yaml +``` + +```yaml +apiVersion: v1 +data: + ca.crt: (APISERVER'S CA BASE64 ENCODED) + namespace: ZGVmYXVsdA== + token: (BEARER TOKEN BASE64 ENCODED) +kind: Secret +metadata: + # ... +type: kubernetes.io/service-account-token +``` + +{{< note >}} +Valores são codificados em base64 porque segredos são sempre codificados neste formato. +{{< /note >}} + +O JWT assinado pode ser usado como um _bearer token_ para autenticar-se como a conta de serviço. Veja [acima](#adicionando-um-bearer-token-em-uma-requisição) como o _token_ pode ser incluído em uma requisição. Normalmente esses segredos são montados no pod para um acesso interno ao cluster ao servidor de API, porém pode ser utilizado fora do cluster também. + +Contas de serviço são autenticadas com o nome de usuário `system:serviceaccount:(NAMESPACE):(SERVICEACCOUNT)` e são atribuídas aos grupos `system:serviceaccounts` e `system:serviceaccounts:(NAMESPACE)`. + +AVISO: porque os _tokens_ das contas de serviço são armazenados em segredos, qualquer usuário com acesso de leitura a esses segredos podem autenticar-se como a conta de serviço. Tome cuidado quando conceder permissões a contas de serviços e capacidade de leitura de segredos. + +### Tokens OpenID Connect + +[OpenID Connect](https://openid.net/connect/) é uma variação do framework de autorização OAuth2 que suporta provedores como Azure Active Directory, Salesforce, e Google. A principal extensão do OAuth2 é um campo adicional de _token_ de acesso chamado [ID Token](https://openid.net/specs/openid-connect-core-1_0.html#IDToken). Este _token_ é um tipo de JSON Web Token (JWT) com campos bem definidos, como usuário, e-mail e é assinado pelo servidor de autorização. + +Para identificar o usuário, o autenticador usa o `id_token` (e não `access_token`) do _bearer token_ da resposta de autorização do OAuth2 [token response](https://openid.net/specs/openid-connect-core-1_0.html#TokenResponse). Veja [acima](#adicionando-um-bearer-token-em-uma-requisição) como incluir um _token_ em uma requisição. + +{{< mermaid >}} +sequenceDiagram + participant usuário as Usuário + participant IDP as Provedor
de Identidade + participant kube as Kubectl + participant API as API Server + + usuário ->> IDP: 1. Realizar Login no IdP + activate IDP + IDP -->> usuário: 2. Fornece access_token,
id_token, e refresh_token + deactivate IDP + activate usuário + usuário ->> kube: 3. Entrar Kubectl
com --token sendo id_token
ou adiciona tokens no arquivo .kube/config + deactivate usuário + activate kube + kube ->> API: 4. Emite requisição incluindo o cabeçalho HTTP Authorization: Bearer... + deactivate kube + activate API + API ->> API: 5. O token do tipo JWT possui assinatura válida ? + API ->> API: 6. O token está expirado ? (iat+exp) + API ->> API: 7. Usuário autorizado ? + API -->> kube: 8. Autorizado: Realiza
ação e retorna resultado + deactivate API + activate kube + kube --x usuário: 9. Retorna resultado + deactivate kube +{{< /mermaid >}} + +1. Login no seu provedor de identidade. +2. Seu provedor de identidade ira fornecer um `access_token`, `id_token` e um `refresh_token`. +3. Quando utilizando `kubectl`, utilize do seu `id_token` com a opção `--token` ou adicione o token diretamente no seu arquivo de configuração `kubeconfig`. +4. `kubectl` envia o seu `id_token` em um cabeçalho HTTP chamado _Authorization_ para o servidor de API. +5. O servidor de API irá garantir que a assinatura do token JWT é válida, verificando-o em relação ao certificado mencionado na configuração. +6. Verificação para garantir que o`id_token` não esteja expirado. +7. Garantir que o usuário é autorizado. +8. Uma vez autorizado o servidor de API retorna a resposta para o `kubectl`. +9. `kubectl` fornece retorno ao usuário. + +Uma vez que todos os dados necessários para determinar sua identidade encontram-se no `id_token`, Kubernetes não precisa realizar outra chamada para o provedor de identidade. Em um modelo onde cada requisição não possui estado, isso fornece uma solução escalável para autenticação. Isso, porem, apresenta alguns desafios: + +1. Kubernetes não possui uma "interface web" para disparar o processo de autenticação. Não há browser ou interface para coletar credenciais que são necessárias para autenticar-se primeiro no seu provedor de identidade. +2. O `id_token` não pode ser revogado, funcionando como um certificado, portanto deve possuir curta validade (somente alguns minutos) o que pode tornar a experiência um pouco desconfortável, fazendo com que se requisite um novo _token_ toda vez em um curto intervalo (poucos minutos de validade do _token_) +3. Para autenticar-se ao dashboard Kubernetes, você deve executar o comando `kubectl proxy` ou um proxy reverso que consiga injetar o `id_token`. + +#### Configurando o Servidor de API + +Para habilitar o plugin de autorização, configure as seguintes opções no servidor de API: + +| Parâmetro | Descrição | Exemplo | Obrigatório | +| --------- | ----------- | ------- | ------- | +| `--oidc-issuer-url` | URL do provedor que permite ao servidor de API descobrir chaves públicas de assinatura. Somente URLs que usam o esquema `https://` são aceitas. Isto normalmente é o endereço de descoberta do provedor sem o caminho, por exemplo "https://accounts.google.com" ou "https://login.salesforce.com". Esta URL deve apontar para o nível abaixo do caminho .well-known/openid-configuration | Se o valor da URL de descoberta é `https://accounts.google.com/.well-known/openid-configuration`, entao o valor deve ser `https://accounts.google.com` | Sim | +| `--oidc-client-id` | Identificador do cliente para o qual todos os tokens são gerados. | kubernetes | Sim | +| `--oidc-username-claim` | Atributo do JWT a ser usado como nome de usuário. Por padrão o valor `sub`, o qual é esperado que seja um identificador único do usuário final. Administradores podem escolher outro atributo, como `email` ou `name`, dependendo de seu provedor de identidade. No entanto, outros atributos além de `email` serão prefixados com a URL do emissor issuer URL para prevenir conflitos de nome com outros plugins. | sub | Não | +| `--oidc-username-prefix` | Prefixos adicionados ao atributo de nome de usuário para prevenir conflitos de nomes existentes (como por exemplo usuários `system:`). Por exemplo, o valor `oidc:` irá criar usuários como `oidc:jane.doe`. Se esta opção não for fornecida `--oidc-username-claim` e um valor diferente de `email` irá conter um prefixo padrão com o valor de `( Issuer URL )#` onde `( Issuer URL )` era o valor da opção `--oidc-issuer-url`. O valor `-` pode ser utilizado para desabilitar todos os prefixos. | `oidc:` | Não | +| `--oidc-groups-claim` | Atributo do JWT a ser utilizado para mapear os grupos dos usuários. Se o atributo está presente, ele deve ser do tipo vetor de Strings. | groups | Não | +| `--oidc-groups-prefix` | Prefixo adicionados ao atributo de grupo para prevenir conflitos de nomes existentes (como por exemplo `system:` grupos). Por exemplo, o valor `oidc:` irá criar nomes de grupos como `oidc:engineering` e `oidc:infra`. | `oidc:` | Não | +| `--oidc-required-claim` | Um par de chave=valor que descreve atributos obrigatórios no _ID Token_. Se configurado, a presença do atributo é verificado dentro do _ID Token_ com um valor relacionado. Repita esta opção para configurar múltiplos atributos obrigatórios. | `claim=value` | Não | +| `--oidc-ca-file` | O caminho para o arquivo de certificado da autoridade de certificados (CA) que assinou o certificado do provedor de identidades. | `/etc/kubernetes/ssl/kc-ca.pem` | Não | + +É importante ressaltar que o servidor de API não é um cliente Oauth2, ao contrário, ele só pode ser configurado para confiar em um emissor. Isso permite o uso de emissores públicos, como Google, sem confiar em credenciais emitidas por terceiros. Administradores que desejam utilizar-se de múltiplos clientes OAuth2 devem explorar provedores os quais suportam atributos `azp` (parte autorizada), que é um mecanismo para permitir um cliente a emitir tokens em nome de outro. + +Kubernetes não oferece um provedor de identidade OpenID Connect. Pode-se utilizar provedores públicos existentes como Google ou [outros](https://connect2id.com/products/nimbus-oauth-openid-connect-sdk/openid-connect-providers). Ou, pode-se rodar o próprio provedor de identidade no cluster, como [dex](https://dexidp.io/), +[Keycloak](https://github.com/keycloak/keycloak), +CloudFoundry [UAA](https://github.com/cloudfoundry/uaa), ou +Tremolo Security's [OpenUnison](https://github.com/tremolosecurity/openunison). + +Para um provedor de identidades funcionar no Kubernetes, ele deve: + +1. Suportar o framework [OpenID connect discovery](https://openid.net/specs/openid-connect-discovery-1_0.html); Nem todos suportam. +2. Executar TLS com cifras criptográficas não obsoletos. +3. Possuir certificados assinados por uma Autoridade certificadora (mesmo que o CA não seja comercial ou seja auto-assinado) + +Uma nota sobre o requisito #3 acima. Se você instalar o seu próprio provedor de identidades (ao invés de utilizar um provedor como Google ou Microsoft) você DEVE ter o certificado web do seu provedor de identidades assinado por um certificado contendo a opção `CA` configurada para `TRUE`, mesmo que seja um certificado auto assinado. Isso deve-se a implementação do cliente TLS em Golang que é bastante restrito quanto aos padrões em torno da validação de certificados. Se você não possui um CA em fácil alcance, você pode usar [este script](https://github.com/dexidp/dex/blob/master/examples/k8s/gencert.sh) criado pelo time Dex para criar um simples CA, um par de chaves e certificado assinados. +Ou você pode usar [este script similar](https://raw.githubusercontent.com/TremoloSecurity/openunison-qs-kubernetes/master/src/main/bash/makessl.sh) o qual gera certificados SHA256 com uma vida mais longa e tamanho maior de chave. + +Instruções de configuração para sistemas específicos podem ser encontrados em: + +- [UAA](https://docs.cloudfoundry.org/concepts/architecture/uaa.html) +- [Dex](https://dexidp.io/docs/kubernetes/) +- [OpenUnison](https://www.tremolosecurity.com/orchestra-k8s/) + +#### Utilizando kubectl + +##### Opção 1 - Autenticador OIDC + +A primeira opção é utilizar-se do autenticador `oidc` do kubectl, o qual define o valor do `id_token` como um _bearer token_ para todas as requisições e irá atualizar o token quando o mesmo expirar. Após você efetuar o login no seu provedor, utilize o kubectl para adicionar os seus `id_token`, `refresh_token`, `client_id`, e `client_secret` para configurar o plugin. + +Provedores os quais não retornem um `id_token` como parte da sua resposta de _refresh token_ não são suportados por este plugin e devem utilizar a opção 2 abaixo. + +```bash +kubectl config set-credentials USER_NAME \ + --auth-provider=oidc \ + --auth-provider-arg=idp-issuer-url=( issuer url ) \ + --auth-provider-arg=client-id=( your client id ) \ + --auth-provider-arg=client-secret=( your client secret ) \ + --auth-provider-arg=refresh-token=( your refresh token ) \ + --auth-provider-arg=idp-certificate-authority=( path to your ca certificate ) \ + --auth-provider-arg=id-token=( your id_token ) +``` + +Um exemplo, executando o comando abaixo após autenticar-se no seu provedor de identidades: + +```bash +kubectl config set-credentials mmosley \ + --auth-provider=oidc \ + --auth-provider-arg=idp-issuer-url=https://oidcidp.tremolo.lan:8443/auth/idp/OidcIdP \ + --auth-provider-arg=client-id=kubernetes \ + --auth-provider-arg=client-secret=1db158f6-177d-4d9c-8a8b-d36869918ec5 \ + --auth-provider-arg=refresh-token=q1bKLFOyUiosTfawzA93TzZIDzH2TNa2SMm0zEiPKTUwME6BkEo6Sql5yUWVBSWpKUGphaWpxSVAfekBOZbBhaEW+VlFUeVRGcluyVF5JT4+haZmPsluFoFu5XkpXk5BXqHega4GAXlF+ma+vmYpFcHe5eZR+slBFpZKtQA= \ + --auth-provider-arg=idp-certificate-authority=/root/ca.pem \ + --auth-provider-arg=id-token=eyJraWQiOiJDTj1vaWRjaWRwLnRyZW1vbG8ubGFuLCBPVT1EZW1vLCBPPVRybWVvbG8gU2VjdXJpdHksIEw9QXJsaW5ndG9uLCBTVD1WaXJnaW5pYSwgQz1VUy1DTj1rdWJlLWNhLTEyMDIxNDc5MjEwMzYwNzMyMTUyIiwiYWxnIjoiUlMyNTYifQ.eyJpc3MiOiJodHRwczovL29pZGNpZHAudHJlbW9sby5sYW46ODQ0My9hdXRoL2lkcC9PaWRjSWRQIiwiYXVkIjoia3ViZXJuZXRlcyIsImV4cCI6MTQ4MzU0OTUxMSwianRpIjoiMm96US15TXdFcHV4WDlHZUhQdy1hZyIsImlhdCI6MTQ4MzU0OTQ1MSwibmJmIjoxNDgzNTQ5MzMxLCJzdWIiOiI0YWViMzdiYS1iNjQ1LTQ4ZmQtYWIzMC0xYTAxZWU0MWUyMTgifQ.w6p4J_6qQ1HzTG9nrEOrubxIMb9K5hzcMPxc9IxPx2K4xO9l-oFiUw93daH3m5pluP6K7eOE6txBuRVfEcpJSwlelsOsW8gb8VJcnzMS9EnZpeA0tW_p-mnkFc3VcfyXuhe5R3G7aa5d8uHv70yJ9Y3-UhjiN9EhpMdfPAoEB9fYKKkJRzF7utTTIPGrSaSU6d2pcpfYKaxIwePzEkT4DfcQthoZdy9ucNvvLoi1DIC-UocFD8HLs8LYKEqSxQvOcvnThbObJ9af71EwmuE21fO5KzMW20KtAeget1gnldOosPtz1G5EwvaQ401-RPQzPGMVBld0_zMCAwZttJ4knw +``` + +O qual irá produzir a configuração abaixo: + +```yaml +users: +- name: mmosley + user: + auth-provider: + config: + client-id: kubernetes + client-secret: 1db158f6-177d-4d9c-8a8b-d36869918ec5 + id-token: eyJraWQiOiJDTj1vaWRjaWRwLnRyZW1vbG8ubGFuLCBPVT1EZW1vLCBPPVRybWVvbG8gU2VjdXJpdHksIEw9QXJsaW5ndG9uLCBTVD1WaXJnaW5pYSwgQz1VUy1DTj1rdWJlLWNhLTEyMDIxNDc5MjEwMzYwNzMyMTUyIiwiYWxnIjoiUlMyNTYifQ.eyJpc3MiOiJodHRwczovL29pZGNpZHAudHJlbW9sby5sYW46ODQ0My9hdXRoL2lkcC9PaWRjSWRQIiwiYXVkIjoia3ViZXJuZXRlcyIsImV4cCI6MTQ4MzU0OTUxMSwianRpIjoiMm96US15TXdFcHV4WDlHZUhQdy1hZyIsImlhdCI6MTQ4MzU0OTQ1MSwibmJmIjoxNDgzNTQ5MzMxLCJzdWIiOiI0YWViMzdiYS1iNjQ1LTQ4ZmQtYWIzMC0xYTAxZWU0MWUyMTgifQ.w6p4J_6qQ1HzTG9nrEOrubxIMb9K5hzcMPxc9IxPx2K4xO9l-oFiUw93daH3m5pluP6K7eOE6txBuRVfEcpJSwlelsOsW8gb8VJcnzMS9EnZpeA0tW_p-mnkFc3VcfyXuhe5R3G7aa5d8uHv70yJ9Y3-UhjiN9EhpMdfPAoEB9fYKKkJRzF7utTTIPGrSaSU6d2pcpfYKaxIwePzEkT4DfcQthoZdy9ucNvvLoi1DIC-UocFD8HLs8LYKEqSxQvOcvnThbObJ9af71EwmuE21fO5KzMW20KtAeget1gnldOosPtz1G5EwvaQ401-RPQzPGMVBld0_zMCAwZttJ4knw + idp-certificate-authority: /root/ca.pem + idp-issuer-url: https://oidcidp.tremolo.lan:8443/auth/idp/OidcIdP + refresh-token: q1bKLFOyUiosTfawzA93TzZIDzH2TNa2SMm0zEiPKTUwME6BkEo6Sql5yUWVBSWpKUGphaWpxSVAfekBOZbBhaEW+VlFUeVRGcluyVF5JT4+haZmPsluFoFu5XkpXk5BXq + name: oidc +``` +Uma vez que seu `id_token` expire, `kubectl` irá tentar atualizar o seu `id_token` utilizando-se do seu `refresh_token` e `client_secret` armazenando os novos valores para `refresh_token` e `id_token` no seu arquivo de configuração `.kube/config`. + +##### Opção 2 - Utilize a opção `--token` + +O comando `kubectl` o permite passar o valor de um token utilizando a opção `--token`. Copie e cole o valor do seu `id_token` nesta opção: + +```bash +kubectl --token=eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwczovL21sYi50cmVtb2xvLmxhbjo4MDQzL2F1dGgvaWRwL29pZGMiLCJhdWQiOiJrdWJlcm5ldGVzIiwiZXhwIjoxNDc0NTk2NjY5LCJqdGkiOiI2RDUzNXoxUEpFNjJOR3QxaWVyYm9RIiwiaWF0IjoxNDc0NTk2MzY5LCJuYmYiOjE0NzQ1OTYyNDksInN1YiI6Im13aW5kdSIsInVzZXJfcm9sZSI6WyJ1c2VycyIsIm5ldy1uYW1lc3BhY2Utdmlld2VyIl0sImVtYWlsIjoibXdpbmR1QG5vbW9yZWplZGkuY29tIn0.f2As579n9VNoaKzoF-dOQGmXkFKf1FMyNV0-va_B63jn-_n9LGSCca_6IVMP8pO-Zb4KvRqGyTP0r3HkHxYy5c81AnIh8ijarruczl-TK_yF5akjSTHFZD-0gRzlevBDiH8Q79NAr-ky0P4iIXS8lY9Vnjch5MF74Zx0c3alKJHJUnnpjIACByfF2SCaYzbWFMUNat-K1PaUk5-ujMBG7yYnr95xD-63n8CO8teGUAAEMx6zRjzfhnhbzX-ajwZLGwGUBT4WqjMs70-6a7_8gZmLZb2az1cZynkFRj2BaCkVT3A2RrjeEwZEtGXlMqKJ1_I2ulrOVsYx01_yD35-rw get nodes +``` + +### Token de autenticação via Webhook + +Webhook de autenticação é usado para verificar _bearer tokens_ + +* `--authentication-token-webhook-config-file` arquivo de configuração descrevendo como acessar o serviço remoto de webhook. +* `--authentication-token-webhook-cache-ttl` por quanto tempo guardar em cache decisões de autenticação. Configuração padrão definida para dois minutos. +* `--authentication-token-webhook-version` determina quando usar o apiVersion `authentication.k8s.io/v1beta1` ou `authentication.k8s.io/v1` para objetos `TokenReview` quando enviar/receber informações do webhook. Valor padrão `v1beta1`. + +O arquivo de configuração usa o formato de arquivo do [kubeconfig](/docs/concepts/configuration/organize-cluster-access-kubeconfig/). Dentro do arquivo, `clusters` refere-se ao serviço remoto e `users` refere-se ao servidor de API do webhook. Um exemplo seria: + +```yaml +# versão da API do Kubernetes +apiVersion: v1 +# tipo do objeto da API +kind: Config +# clusters refere-se ao serviço remoto +clusters: + - name: name-of-remote-authn-service + cluster: + certificate-authority: /path/to/ca.pem # CA para verificar o serviço remoto + server: https://authn.example.com/authenticate # URL para procurar o serviço remoto. Deve utilizar 'https'. + +# users refere-se a configuração do webhook do servidor de API +users: + - name: name-of-api-server + user: + client-certificate: /path/to/cert.pem # certificado para ser utilizado pelo plugin de webhook + client-key: /path/to/key.pem # chave referente ao certificado + +# arquivos kubeconfig requerem um contexto. Especifique um para o servidor de API. +current-context: webhook +contexts: +- context: + cluster: name-of-remote-authn-service + user: name-of-api-server + name: webhook +``` + +Quando um cliente tenta autenticar-se com o servidor de API utilizando um _bearer token_ como discutido [acima](#adicionando-um-bearer-token-em-uma-requisição), o webhook de autenticação envia um objeto JSON serializado do tipo `TokenReview` contendo o valor do _token_ para o serviço remoto. + +Note que objetos de API do tipo _webhook_ estão sujeitos às mesmas [regras de compatibilidade de versão](/docs/concepts/overview/kubernetes-api/) como outros objetos de API Kubernetes. +Implementadores devem verificar o campo de versão da API (`apiVersion`) da requisição para garantir a correta deserialização e **devem** responder com um objeto do tipo `TokenReview` da mesma versão da requisição. + +{{< tabs name="TokenReview_request" >}} +{{% tab name="authentication.k8s.io/v1" %}} +{{< note >}} +O servidor de API Kubernetes envia por padrão revisão de tokens para a API `authentication.k8s.io/v1beta1` para fins de compatibilidade com versões anteriores. + +Para optar receber revisão de tokens de versão `authentication.k8s.io/v1`, o servidor de API deve ser inicializado com a opção `--authentication-token-webhook-version=v1`. +{{< /note >}} + +```yaml +{ + "apiVersion": "authentication.k8s.io/v1", + "kind": "TokenReview", + "spec": { + # Bearer token opaco enviado para o servidor de API + "token": "014fbff9a07c...", + + # Lista opcional de identificadores de audiência para o servidor ao qual o token foi apresentado + # Autenticadores de token sensíveis a audiência (por exemplo, autenticadores de token OIDC) + # deve-se verificar que o token foi direcionado a pelo menos um membro da lista de audiência + # e retornar a interseção desta lista a audiência válida para o token no estado da resposta + # Isto garante com que o token é válido para autenticar-se no servidor ao qual foi apresentado + # Se nenhuma audiência for especificada, o token deve ser validado para autenticar-se ao servidor de API do Kubernetes + "audiences": ["https://myserver.example.com", "https://myserver.internal.example.com"] + } +} +``` +{{% /tab %}} +{{% tab name="authentication.k8s.io/v1beta1" %}} +```yaml +{ + "apiVersion": "authentication.k8s.io/v1beta1", + "kind": "TokenReview", + "spec": { + # Bearer token opaco enviado para o servidor de API + "token": "014fbff9a07c...", + + # Lista opcional de identificadores de audiência para o servidor ao qual o token foi apresentado + # Autenticadores de token sensíveis a audiência (por exemplo, autenticadores de token OIDC) + # deve-se verificar que o token foi direcionado a pelo menos um membro da lista de audiência + # e retornar a interseção desta lista a audiência válida para o token no estado da resposta + # Isto garante com que o token é válido para autenticar-se no servidor ao qual foi apresentado + # Se nenhuma audiência for especificada, o token deve ser validado para autenticar-se ao servidor de API do Kubernetes + "audiences": ["https://myserver.example.com", "https://myserver.internal.example.com"] + } +} +``` +{{% /tab %}} +{{< /tabs >}} + +É esperado que o serviço remoto preencha o campo `status` da requisição para indicar o sucesso do login. +O campo `spec` do corpo de resposta é ignorado e pode ser omitido. +O serviço remoto deverá retornar uma resposta usando a mesma versão de API do objeto `TokenReview` que foi recebido. +Uma validação bem sucedida deveria retornar: + +{{< tabs name="TokenReview_response_success" >}} +{{% tab name="authentication.k8s.io/v1" %}} +```yaml +{ + "apiVersion": "authentication.k8s.io/v1", + "kind": "TokenReview", + "status": { + "authenticated": true, + "user": { + # Obrigatório + "username": "janedoe@example.com", + # Opcional + "uid": "42", + # Opcional: lista de grupos associados + "groups": ["developers", "qa"], + # Opcional: informação adicional provida pelo autenticador. + # Isto não deve conter dados confidenciais, pois pode ser registrados em logs ou em objetos de API e estarão disponíveis para webhooks de admissão + "extra": { + "extrafield1": [ + "extravalue1", + "extravalue2" + ] + } + }, + # Lista opcional de Autenticadores de token sensíveis a audiência que podem ser retornados, + # contendo as audiências da lista `spec.audiences` válido para o token apresentado. + # Se este campo for omitido, o token é considerado válido para autenticar-se no servidor de API Kubernetes + "audiences": ["https://myserver.example.com"] + } +} +``` +{{% /tab %}} +{{% tab name="authentication.k8s.io/v1beta1" %}} +```yaml +{ + "apiVersion": "authentication.k8s.io/v1beta1", + "kind": "TokenReview", + "status": { + "authenticated": true, + "user": { + # Obrigatório + "username": "janedoe@example.com", + # Opcional + "uid": "42", + # Opcional: lista de grupos associados + "groups": ["developers", "qa"], + # Opcional: informação adicional provida pelo autenticador. + # Isto não deve conter dados confidenciais, pois pode ser registrados em logs ou em objetos de API e estarão disponíveis para webhooks de admissão + "extra": { + "extrafield1": [ + "extravalue1", + "extravalue2" + ] + } + }, + # Lista opcional de Autenticadores de token sensíveis a audiência que podem ser retornados, + # contendo as audiências da lista `spec.audiences` válido para o token apresentado. + # Se este campo for omitido, o token é considerado válido para autenticar-se no servidor de API Kubernetes + "audiences": ["https://myserver.example.com"] + } +} +``` +{{% /tab %}} +{{< /tabs >}} + +Uma requisição mal sucedida retornaria: + +{{< tabs name="TokenReview_response_error" >}} +{{% tab name="authentication.k8s.io/v1" %}} +```yaml +{ + "apiVersion": "authentication.k8s.io/v1", + "kind": "TokenReview", + "status": { + "authenticated": false, + # Opcionalmente inclui detalhes sobre o porque a autenticação falhou + # Se nenhum erro é fornecido, a API irá retornar uma mensagem genérica de "Não autorizado" + # O campo de erro é ignorado quando authenticated=true. + "error": "Credenciais expiradas" + } +} +``` +{{% /tab %}} +{{% tab name="authentication.k8s.io/v1beta1" %}} +```yaml +{ + "apiVersion": "authentication.k8s.io/v1beta1", + "kind": "TokenReview", + "status": { + "authenticated": false, + # Opcionalmente inclui detalhes sobre o porque a autenticação falhou + # Se nenhum erro é fornecido, a API irá retornar uma mensagem genérica de "Não autorizado" + # O campo de erro é ignorado quando authenticated=true. + "error": "Credenciais expiradas" + } +} +``` +{{% /tab %}} +{{< /tabs >}} + +### Autenticando com Proxy + +O servidor de API pode ser configurado para identificar usuários através de valores de cabeçalho de requisição, como por exemplo `X-Remote-User`. +Isto é projetado para o uso em combinação com um proxy de autenticação, o qual irá atribuir o valor do cabeçalho da requisição. + +* `--requestheader-username-headers` Obrigatório, não faz distinção entre caracteres maiúsculos/minúsculos. Nomes de cabeçalhos a serem verificados, em ordem, para a identidade do usuário. O primeiro cabeçalho contendo um valor será usado para o nome do usuário. +* `--requestheader-group-headers` 1.6+. Opcional, não faz distinção entre caracteres maiúsculos/minúsculos. "X-Remote-Group" é recomendado. Nomes de cabeçalhos a serem verificados, em ordem, para os grupos do usuário. Todos os valores especificados em todos os cabeçalhos serão utilizados como nome dos grupos do usuário. + +* `--requestheader-extra-headers-prefix` 1.6+. Opcional, não faz distinção entre caracteres maiúsculos/minúsculos. "X-Remote-Extra-" é recomendado. Prefixos de cabeçalhos para serem utilizados para definir informações extras sobre o usuário (normalmente utilizado por um plugin de autorização). Todos os cabeçalhos que começam com qualquer um dos prefixos especificados têm o prefixo removido. O restante do nome do cabeçalho é transformado em letra minúscula, decodificado [percent-decoded](https://tools.ietf.org/html/rfc3986#section-2.1) e torna-se uma chave extra, e o valor do cabeçalho torna-se um valor extra. + +{{< note >}} +Antes da versão 1.11.3 (e 1.10.7, 1.9.11), a chave extra só poderia conter caracteres os quais fossem [legais em rótulos de cabeçalhos HTTP](https://tools.ietf.org/html/rfc7230#section-3.2.6). +{{< /note >}} + +Por exemplo, com esta configuração: + +``` +--requestheader-username-headers=X-Remote-User +--requestheader-group-headers=X-Remote-Group +--requestheader-extra-headers-prefix=X-Remote-Extra- +``` + +e esta requisição: + +```http +GET / HTTP/1.1 +X-Remote-User: fido +X-Remote-Group: dogs +X-Remote-Group: dachshunds +X-Remote-Extra-Acme.com%2Fproject: some-project +X-Remote-Extra-Scopes: openid +X-Remote-Extra-Scopes: profile +``` + +resultaria nesta informação de usuário: + +```yaml +name: fido +groups: +- dogs +- dachshunds +extra: + acme.com/project: + - some-project + scopes: + - openid + - profile +``` + +Para prevenir falsificação de cabeçalhos, o proxy de autenticação deverá apresentar um certificado de cliente válido para o servidor de API para que possa ser validado com a autoridade de certificados (CA) antes que os cabeçalhos de requisições sejam verificados. AVISO: **não** re-utilize uma autoridade de certificados (CA) que esteja sendo utilizado em um contexto diferente ao menos que você entenda os riscos e os mecanismos de proteção da utilização de uma autoridade de certificados. + +* `--requestheader-client-ca-file` Obrigatório. Pacote de certificados no formato PEM. Um certificado válido deve ser apresentado e validado com a autoridade de certificados no arquivo especificado antes da verificação de cabeçalhos de requisição para os nomes do usuário. + +* `--requestheader-allowed-names` Opcional. Lista de valores de nomes comuns (CNs). Se especificado, um certificado de cliente válido contendo uma lista de nomes comuns denominados deve ser apresentado na verificação de cabeçalhos de requisição para os nomes do usuário. Se vazio, qualquer valor de nomes comuns será permitido. + +## Requisições anônimas + +Quando habilitado, requisições que não são rejeitadas por outros métodos de autenticação configurados são tratadas como requisições anônimas e são dadas o nome de usuário `system:anonymous` e filiação ao grupo `system:unauthenticated`. + +Por exemplo, uma requisição especificando um _bearer token_ invalido chega a um servidor com token de autenticação configurado e acesso anônimo habilitado e receberia um erro de acesso não autorizado `401 Unauthorized`. Já uma requisição não especificando nenhum _bearer token_ seria tratada como uma requisição anônima. + +Nas versões 1.5.1-1.5.x, acesso anônimo é desabilitado por padrão e pode ser habilitado passando a opção `--anonymous-auth=true` durante a inicialização do servidor de API. + +Na versão 1.6 e acima, acesso anônimo é habilitado por padrão se um modo de autorização diferente de `AlwaysAllow` é utilizado e pode ser desabilitado passando a opção `--anonymous-auth=false` durante a inicialização do servidor de API. +Começando na versão 1.6, os autorizadores _ABAC (Controle de Acesso Baseado em Atributos)_ e _RBAC (Controle de Acesso Baseado em Função)_ requerem autorização explícita do usuário `system:anonymous` e do grupo `system:unauthenticated`, portanto, regras de políticas legadas que permitam acesso a usuário `*` e grupo `*` nao incluíram usuários anônimos. + +## Personificação de usuário + +Um usuário pode agir como outro através de cabeçalhos de personificação. Os mesmos permitem que requisições manualmente sobrescrevam as informações ao quais o usuário irá se autenticar como. Por exemplo, um administrador pode utilizar-se desta funcionalidade para investigar um problema com uma política de autorização e assim, temporariamente, personificar um outro usuário e ver se/como sua requisição está sendo negada. + +Requisições de personificação primeiramente são autenticadas como o usuário requerente, então trocando para os detalhes de informação do usuário personificado. + +O fluxo é: + +* Um usuário faz uma chamada de API com suas credenciais _e_ cabeçalhos de personificação. +* O servidor de API autentica o usuário. +* O servidor de API garante que o usuário autenticado possui permissão de personificação. +* Detalhes de informação do usuário da requisição tem seus valores substituídos com os detalhes de personificação. +* A requisição é avaliada e a autorização é feita sobre os detalhes do usuário personificado. + +Os seguintes cabeçalhos HTTP podem ser usados para realizar uma requisição de personificação: + +* `Impersonate-User`: O nome do usuário para se executar ações em seu nome. +* `Impersonate-Group`: Um nome de grupo para se executar ações em seu nome. Pode ser especificado múltiplas vezes para fornecer múltiplos grupos. Opcional. Requer "Impersonate-User". +* `Impersonate-Extra-( extra name )`: Um cabeçalho dinâmico usado para associar campos extras do usuário. Opcional. Requer "Impersonate-User". Para que seja preservado consistentemente, `( extra name )` deve ser somente minúsculo, e qualquer caracter que não seja [legal em rótulos de cabeçalhos HTTP](https://tools.ietf.org/html/rfc7230#section-3.2.6) DEVE ser utf8 e [codificado](https://tools.ietf.org/html/rfc3986#section-2.1). + +{{< note >}} +Antes da versão 1.11.3 (e 1.10.7, 1.9.11), `( extra name )` só poderia conter caracteres que fossem [legais em rótulos de cabeçalhos HTTP](https://tools.ietf.org/html/rfc7230#section-3.2.6). +{{< /note >}} + +Um exemplo de conjunto de cabeçalhos HTTP: + +```http +Impersonate-User: jane.doe@example.com +Impersonate-Group: developers +Impersonate-Group: admins +Impersonate-Extra-dn: cn=jane,ou=engineers,dc=example,dc=com +Impersonate-Extra-acme.com%2Fproject: some-project +Impersonate-Extra-scopes: view +Impersonate-Extra-scopes: development +``` + +Quando utilizando-se o `kubectl` especifique a opção `--as` para determinar o cabeçalho `Impersonate-User`, especifique a opção `--as-group` para determinar o cabeçalho `Impersonate-Group`. + +```bash +kubectl drain mynode +``` + +```none +Error from server (Forbidden): User "clark" cannot get nodes at the cluster scope. (get nodes mynode) +``` + +Especificando as opções `--as` e `--as-group`: + +```bash +kubectl drain mynode --as=superman --as-group=system:masters +``` + +```none +node/mynode cordoned +node/mynode drained +``` + +Para personificar um usuário, grupo ou especificar campos extras, o usuário efetuando a personificação deve possuir a permissão de executar o verbo "impersonate" no tipo de atributo sendo personificado ("user", "group", etc.). Para clusters com o plugin de autorização _RBAC_ habilitados, a seguinte ClusterRole abrange as regras necessárias para definir os cabeçalhos de personificação de usuário e grupo: + +```yaml +apiVersion: rbac.authorization.k8s.io/v1 +kind: ClusterRole +metadata: + name: impersonator +rules: +- apiGroups: [""] + resources: ["users", "groups", "serviceaccounts"] + verbs: ["impersonate"] +``` + +Campos extras são avaliados como sub-recursos de um recurso denominado "userextras". Para permitir ao usuário que utilize os cabeçalhos de personificação para o campo extra "scopes", o usuário deve receber a seguinte permissão: + +```yaml +apiVersion: rbac.authorization.k8s.io/v1 +kind: ClusterRole +metadata: + name: scopes-impersonator +rules: +# Pode definir o cabeçalho "Impersonate-Extra-scopes". +- apiGroups: ["authentication.k8s.io"] + resources: ["userextras/scopes"] + verbs: ["impersonate"] +``` +Os valores dos cabeçalhos de personificação podem também ser restringidos ao limitar o conjunto de nomes de recursos (`resourceNames`) que um recurso pode ter. + +```yaml +apiVersion: rbac.authorization.k8s.io/v1 +kind: ClusterRole +metadata: + name: limited-impersonator +rules: +# Pode personificar o usuário "jane.doe@example.com" +- apiGroups: [""] + resources: ["users"] + verbs: ["impersonate"] + resourceNames: ["jane.doe@example.com"] + +# Pode assumir os grupos "developers" and "admins" +- apiGroups: [""] + resources: ["groups"] + verbs: ["impersonate"] + resourceNames: ["developers","admins"] + +# Pode personificar os campos extras "scopes" com valores "view" e "development" +- apiGroups: ["authentication.k8s.io"] + resources: ["userextras/scopes"] + verbs: ["impersonate"] + resourceNames: ["view", "development"] +``` + +## Plugins de credenciais client-go +{{< feature-state for_k8s_version="v1.11" state="beta" >}} + +Ferramentas como `kubectl` e `kubelet` utilizando-se do `k8s.io/client-go` são capazes de executar um comando externo para receber credenciais de usuário. + +Esta funcionalidade é direcionada à integração do lado cliente, com protocolos de autenticação não suportados nativamente pelo `k8s.io/client-go` como: LDAP, Kerberos, OAuth2, SAML, etc. O plugin implementa a lógica específica do protocolo e então retorna credenciais opacas para serem utilizadas. Quase todos os casos de usos de plugins de credenciais requerem um componente de lado do servidor com suporte para um [autenticador de token webhook](#token-de-autenticação-via-webhook) para interpretar o formato das credenciais produzidas pelo plugin cliente. + +### Exemplo de caso de uso + +Num caso de uso hipotético, uma organização executaria um serviço externo que efetuaria a troca de credenciais LDAP por tokens assinados para um usuário específico. Este serviço seria também capaz de responder requisições do [autenticador de token webhook](#token-de-autenticação-via-webhook) para validar tokens. Usuários seriam obrigados a instalar um plugin de credencial em sua estação de trabalho. + +Para autenticar na API: +* O usuário entra um comando `kubectl`. +* O plugin de credencial solicita ao usuário a entrada de credenciais LDAP e efetua troca das credenciais por um token via um serviço externo. +* O plugin de credenciais retorna um token para o client-go, o qual o utiliza como um bearer token no servidor de API. +* O servidor de API usa o [autenticador de token webhook](#token-de-autenticação-via-webhook) para submeter um objeto `TokenReview` para o serviço externo. +* O serviço externo verifica a assinatura do token e retorna o nome e grupos do usuário. + +### Configuração + +plugins de credencial são configurados através de [arquivos de configuração do kubectl](/docs/tasks/access-application-cluster/configure-access-multiple-clusters/) como parte dos campos de usuário. + +```yaml +apiVersion: v1 +kind: Config +users: +- name: my-user + user: + exec: + # Comando a ser executado. Obrigatório. + command: "example-client-go-exec-plugin" + + # Versão da API a ser utilizada quando decodificar o recurso ExecCredentials. Obrigatório + # + # A versão da API retornada pelo plugin DEVE ser a mesma versão listada aqui. + # + # Para integrar com ferramentas que suportem múltiplas versões (tal como client.authentication.k8s.io/v1alpha1), + # defina uma variável de ambiente ou passe um argumento para a ferramenta que indique qual versão o plugin de execução deve esperar. + apiVersion: "client.authentication.k8s.io/v1beta1" + + # Variáveis de ambiente a serem configuradas ao executar o plugin. Opcional + env: + - name: "FOO" + value: "bar" + + # Argumentos a serem passados ao executar o plugin. Opcional + args: + - "arg1" + - "arg2" + + # Texto exibido para o usuário quando o executável não parece estar presente. Opcional + installHint: | + example-client-go-exec-plugin é necessário para autenticar no cluster atual. Pode ser instalado via: + + Em macOS: brew install example-client-go-exec-plugin + + Em Ubuntu: apt-get install example-client-go-exec-plugin + + Em Fedora: dnf install example-client-go-exec-plugin + + ... + + # Deve-se ou não fornecer informações do cluster, que podem potencialmente conter grande quantidade de dados do CA, + # para esse plugin de execução como parte da variável de ambiente KUBERNETES_EXEC_INFO + provideClusterInfo: true +clusters: +- name: my-cluster + cluster: + server: "https://172.17.4.100:6443" + certificate-authority: "/etc/kubernetes/ca.pem" + extensions: + - name: client.authentication.k8s.io/exec # nome de extensão reservado para configuração exclusiva do cluster + extension: + arbitrary: config + this: pode ser fornecido através da variável de ambiente KUBERNETES_EXEC_INFO na configuracao de provideClusterInfo + you: ["coloque", "qualquer", "coisa", "aqui"] +contexts: +- name: my-cluster + context: + cluster: my-cluster + user: my-user +current-context: my-cluster +``` + +Os caminhos relativos do comando são interpretados como relativo ao diretório do arquivo de configuração. Se +KUBECONFIG está configurado para o caminho `/home/jane/kubeconfig` e o comando executado é `./bin/example-client-go-exec-plugin`, +o binario `/home/jane/bin/example-client-go-exec-plugin` será executado. + +```yaml +- name: my-user + user: + exec: + # Caminho relativo para o diretorio do kubeconfig + command: "./bin/example-client-go-exec-plugin" + apiVersion: "client.authentication.k8s.io/v1beta1" +``` + +### Formatos de entrada e saída + +O comando executado imprime um objeto `ExecCredential` para o `stdout`. `k8s.io/client-go` +autentica na API do Kubernetes utilizando as credenciais retornadas no `status`. + +Quando executando uma sessão interativa, `stdin` é exposto diretamente para o plugin. plugins devem utilizar +um [TTY check](https://godoc.org/golang.org/x/crypto/ssh/terminal#IsTerminal) para determinar se é +apropriado solicitar um usuário interativamente. + +Para usar credenciais do tipo _bearer token_, o plugin retorna um token no status do objeto `ExecCredential`. + +```json +{ + "apiVersion": "client.authentication.k8s.io/v1beta1", + "kind": "ExecCredential", + "status": { + "token": "my-bearer-token" + } +} +``` + +Alternativamente, um certificado de cliente e chave codificados em PEM podem ser retornados para serem utilizados em autenticação de cliente TLS. +Se o plugin retornar um certificado e chave diferentes numa chamada subsequente, `k8s.io/client-go` +Irá fechar conexões existentes com o servidor para forçar uma nova troca TLS. + +Se especificado, `clientKeyData` e `clientCertificateData` devem ambos estar presentes. + +`clientCertificateData` pode conter certificados intermediários adicionais a serem enviados para o servidor. + +```json +{ + "apiVersion": "client.authentication.k8s.io/v1beta1", + "kind": "ExecCredential", + "status": { + "clientCertificateData": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----", + "clientKeyData": "-----BEGIN RSA PRIVATE KEY-----\n...\n-----END RSA PRIVATE KEY-----" + } +} +``` + +Opcionalmente, a resposta pode incluir a validade da credencial em formato +RFC3339 de data/hora. A presença ou ausência de validade pode ter o seguinte impacto: + +- Se uma validade está incluída, o _bearer token_ e as credenciais TLS são guardadas em cache até +a o tempo de expiração é atingido ou se o servidor responder com um codigo de status HTTP 401 +ou se o processo terminar. + +- Se uma validate está ausente, o _bearer token_ e as credenciais TLS são guardadas em cache até +o servidor responder com um código de status HTTP 401 ou até o processo terminar. + +```json +{ + "apiVersion": "client.authentication.k8s.io/v1beta1", + "kind": "ExecCredential", + "status": { + "token": "my-bearer-token", + "expirationTimestamp": "2018-03-05T17:30:20-08:00" + } +} +``` + +Para habilitar o plugin de execução para obter informações específicas do cluster, define `provideClusterInfo` no campo `user.exec` +dentro do arquivo de configuração [kubeconfig](/docs/concepts/configuration/organize-cluster-access-kubeconfig/). +O plugin irá então prover a variável de ambiente `KUBERNETES_EXEC_INFO`. +As informações desta variável de ambiente podem ser utilizadas para executar lógicas de aquisição +de credentiais específicas do cluster. +O manifesto `ExecCredential` abaixo descreve um exemplo de informação de cluster. + +```json +{ + "apiVersion": "client.authentication.k8s.io/v1beta1", + "kind": "ExecCredential", + "spec": { + "cluster": { + "server": "https://172.17.4.100:6443", + "certificate-authority-data": "LS0t...", + "config": { + "arbitrary": "config", + "this": "pode ser fornecido por meio da variável de ambiente KUBERNETES_EXEC_INFO na configuração de provideClusterInfo", + "you": ["coloque", "qualquer", "coisa", "aqui"] + } + } + } +} +``` \ No newline at end of file diff --git a/content/pt/docs/reference/glossary/alternate-x509-schemes.md b/content/pt/docs/reference/glossary/alternate-x509-schemes.md new file mode 100644 index 0000000000..307479595d --- /dev/null +++ b/content/pt/docs/reference/glossary/alternate-x509-schemes.md @@ -0,0 +1,27 @@ +--- +title: Esquemas alternativos x509 +id: alternate-x509-schemes +date: 2021-03-16 +full_link: +short_description: > + X.509 é um formato padrão para certificados de chave pública, documentos digitais que associam com segurança pares de chaves criptográficas a identidades como sites, indivíduos ou organizações. + +aka: +tags: +- authentication +--- + + + +X.509 é um formato padrão para certificados de chave pública, documentos digitais que associam com segurança pares de chaves criptográficas a identidades como sites, indivíduos ou organizações. + +Introduzido pela primeira vez em 1988 junto com os padrões X.500 para serviços de diretório eletrônico, o X.509 foi adaptado para uso na Internet pelo grupo de trabalho Public-Key Infrastructure (X.509) (PKIX) da IETF. O RFC 5280 define o perfil do certificado X.509 v3, a lista de revogação de certificado X.509 v2 (CRL) e descreve um algoritmo para a validação do caminho do certificado X.509. + +As aplicações comuns de certificados X.509 incluem: + + - SSL / TLS e HTTPS para navegação na web autenticada e criptografada + - E-mail assinado e criptografado por meio do protocolo S / MIME + - Assinatura de código + - Assinatura de documento + - Autenticação de cliente + - Identificação eletrônica emitida pelo governo diff --git a/content/pt/docs/reference/glossary/kerberos.md b/content/pt/docs/reference/glossary/kerberos.md new file mode 100644 index 0000000000..7752654082 --- /dev/null +++ b/content/pt/docs/reference/glossary/kerberos.md @@ -0,0 +1,27 @@ +--- +title: Kerberos +id: kerberos +date: 2021-03-16 +full_link: +short_description: > + Kerberos é um protocolo de rede que usa criptografia de chave secreta para autenticar aplicativos cliente-servidor. O Kerberos solicita um tíquete criptografado por meio de uma sequência de servidor autenticada para usar os serviços. + + O protocolo recebe o nome do cão de três cabeças (Kerberos ou Cerberus) que guardava os portões de Hades na mitologia grega. + +aka: +tags: +- authentication +--- + + + +Kerberos é um protocolo de rede que usa criptografia de chave secreta para autenticar aplicativos cliente-servidor. O Kerberos solicita um tíquete criptografado por meio de uma sequência de servidor autenticada para usar os serviços. + +Kerberos foi desenvolvido pelo Project Athena - um projeto conjunto entre o Massachusetts Institute of Technology (MIT), Digital Equipment Corporation e IBM que funcionou entre 1983 e 1991. + +Um servidor de autenticação usa um tíquete Kerberos para conceder acesso ao servidor e, em seguida, cria uma chave de sessão com base na senha do solicitante e outro valor aleatório. O tíquete de concessão de tíquete (TGT) é enviado ao servidor de concessão de tíquete (TGS), que é necessário para usar o mesmo servidor de autenticação. + +O solicitante recebe uma chave TGS criptografada com um registro de data e hora e um tíquete de serviço, que é retornado ao solicitante e descriptografado. O solicitante envia ao TGS essas informações e encaminha a chave criptografada ao servidor para obter o serviço desejado. Se todas as ações forem tratadas corretamente, o servidor aceita o tíquete e realiza o atendimento ao usuário desejado, que deve descriptografar a chave, verificar a data e hora e entrar em contato com o centro de distribuição para obter as chaves de sessão. Essa chave de sessão é enviada ao solicitante, que descriptografa o tíquete. + +Se as chaves e o carimbo de data / hora forem válidos, a comunicação cliente-servidor continuará. O tíquete TGS tem carimbo de data / hora, o que permite solicitações simultâneas dentro do período de tempo alocado. + diff --git a/content/pt/docs/reference/glossary/keystone.md b/content/pt/docs/reference/glossary/keystone.md new file mode 100644 index 0000000000..6a59f1d1b9 --- /dev/null +++ b/content/pt/docs/reference/glossary/keystone.md @@ -0,0 +1,16 @@ +--- +title: Keystone +id: keystore +date: 2020-08-03 +full_link: +short_description: > + Keystone é o serviço de identidade usado pelo OpenStack para autenticação (authN) e autorização de alto nível (authZ). Atualmente, ele oferece suporte a authN com base em token e autorização de serviço do usuário. Recentemente, foi reprojetado para permitir a expansão para oferecer suporte a serviços externos de proxy e mecanismos AuthN / AuthZ, como oAuth, SAML e openID em versões futuras. + +aka: +tags: +- authentication +--- + + +Keystone é o serviço de identidade usado pelo OpenStack para autenticação (authN) e autorização de alto nível (authZ). Atualmente, ele oferece suporte a authN com base em token e autorização de serviço do usuário. Recentemente, foi reprojetado para permitir a expansão para oferecer suporte a serviços externos de proxy e mecanismos AuthN / AuthZ, como oAuth, SAML e openID em versões futuras. + diff --git a/content/pt/docs/reference/glossary/ldap.md b/content/pt/docs/reference/glossary/ldap.md new file mode 100644 index 0000000000..2a15eaa6ab --- /dev/null +++ b/content/pt/docs/reference/glossary/ldap.md @@ -0,0 +1,28 @@ +--- +title: LDAP +id: ldap +date: 2021-03-16 +full_link: +short_description: > + Abreviatura para "Lightweight Directory Access Protocol". Se você deseja disponibilizar informações de diretório na Internet, esta é a maneira de fazê-lo. O LDAP é uma versão simplificada de um padrão de diretório anterior denominado X.500. + +aka: +tags: +- authentication +--- + + +Abreviatura para "Lightweight Directory Access Protocol". Se você deseja disponibilizar informações de diretório na Internet, esta é a maneira de fazê-lo. O LDAP é uma versão simplificada de um padrão de diretório anterior denominado X.500. O que torna o LDAP tão útil é que ele funciona muito bem em redes TCP / IP (ao contrário do X.500), de modo que as informações podem ser acessadas por meio do LDAP por qualquer pessoa com uma conexão à Internet. Também é um protocolo aberto, o que significa que os diretórios podem ser armazenados em qualquer tipo de máquina (por exemplo, Windows 2000, Red Hat Linux, Mac OS X). + +Para dar uma ideia de como um diretório LDAP é organizado, aqui estão os diferentes níveis de uma hierarquia de árvore LDAP simples: + +O diretório raiz +Países +Organizações +Divisões, departamentos, etc. +Indivíduos +Recursos individuais, como arquivos e impressoras. +A maior parte da conectividade LDAP é feita nos bastidores, então o usuário típico provavelmente não notará ao navegar na web. No entanto, é uma boa tecnologia para se conhecer. Se nada mais, é outro termo para impressionar seus pais. + + + diff --git a/content/pt/docs/reference/glossary/saml.md b/content/pt/docs/reference/glossary/saml.md new file mode 100644 index 0000000000..e283179742 --- /dev/null +++ b/content/pt/docs/reference/glossary/saml.md @@ -0,0 +1,36 @@ +--- +title: SAML +id: saml +date: 2021-03-16 +full_link: +short_description: > + SAML significa Linguagem de Marcação para Asserção de Segurança. É um padrão aberto baseado em XML para transferência de dados de identidade entre duas partes: um provedor de identidade (IdP) e um provedor de serviços (SP). + +aka: +tags: +- authentication +--- + + +SAML significa Linguagem de Marcação para Asserção de Segurança. É um padrão aberto baseado em XML para transferência de dados de identidade entre duas partes: um provedor de identidade (IdP) e um provedor de serviços (SP). + +Provedor de identidade - executa autenticação e passa a identidade do usuário e o nível de autorização para o provedor de serviços. + +Provedor de serviços - confia no provedor de identidade e autoriza o usuário fornecido a acessar o recurso solicitado. + +A autenticação de logon único SAML normalmente envolve um provedor de serviços e um provedor de identidade. O fluxo do processo geralmente envolve os estágios de estabelecimento de confiança e fluxo de autenticação. + +Considere este exemplo: + +Nosso provedor de identidade é Auth0 +Nosso provedor de serviços é um serviço fictício, Zagadat +Nota: O provedor de identidade pode ser qualquer plataforma de gerenciamento de identidade. + +Agora, um usuário está tentando obter acesso ao Zagadat usando a autenticação SAML. + +Este é o fluxo do processo: + +O usuário tenta fazer login no Zagadat a partir de um navegador. +O Zagadat responde gerando uma solicitação SAML. + + diff --git a/content/pt/docs/reference/glossary/tls-common-name.md b/content/pt/docs/reference/glossary/tls-common-name.md new file mode 100644 index 0000000000..afa5af96e0 --- /dev/null +++ b/content/pt/docs/reference/glossary/tls-common-name.md @@ -0,0 +1,18 @@ +--- +title: TLS Common Name +id: tls-common-name +date: 2021-03-16 +full_link: +short_description: > + O nome comum é normalmente composto de Host + Nome de domínio e será semelhante a www.seusite.com ou seusite.com. Os certificados de servidor SSL são específicos para o nome comum para o qual foram emitidos no nível do host. + +aka: +tags: +- authentication +--- + + + +O nome comum é normalmente composto de Host + Nome de domínio e será semelhante a www.seusite.com ou seusite.com. Os certificados de servidor SSL são específicos para o nome comum para o qual foram emitidos no nível do host. + +O nome comum deve ser igual ao endereço da Web que você acessará ao se conectar a um site seguro. Por exemplo, um certificado de servidor SSL para o domínio domínio.com receberá um aviso do navegador se o acesso a um site chamado www.domain.com ou secure.domain.com, pois www.domain.com e secure.domain.com são diferentes de dominio.com. Você precisaria criar um CSR para o nome comum correto. \ No newline at end of file diff --git a/content/pt/docs/reference/glossary/uid.md b/content/pt/docs/reference/glossary/uid.md new file mode 100644 index 0000000000..c5e34fd185 --- /dev/null +++ b/content/pt/docs/reference/glossary/uid.md @@ -0,0 +1,13 @@ +--- +title: UID +id: uid +date: 2021-03-16 +full_link: +short_description: > + Um identificador exclusivo (UID) é uma sequência numérica ou alfanumérica associada a uma única entidade em um determinado sistema. + +aka: +tags: +- authentication +--- +Um identificador exclusivo (UID) é uma sequência numérica ou alfanumérica associada a uma única entidade em um determinado sistema. Os UIDs tornam possível endereçar essa entidade para que ela possa ser acessada e interagida. Cada usuário é identificado no sistema por seu UID e os nomes de usuário geralmente são usados apenas como uma interface para humanos. \ No newline at end of file diff --git a/content/pt/docs/reference/glossary/username.md b/content/pt/docs/reference/glossary/username.md new file mode 100644 index 0000000000..30b516eb5d --- /dev/null +++ b/content/pt/docs/reference/glossary/username.md @@ -0,0 +1,16 @@ +--- +title: Username +id: username +date: 2021-03-16 +full_link: +short_description: > + Um nome de usuário é um nome que identifica exclusivamente alguém em um sistema de computador. + +aka: +tags: +- authentication +--- +Um nome de usuário é um nome que identifica exclusivamente alguém em um sistema de computador. Por exemplo, um computador pode ser configurado com várias contas, com nomes de usuário diferentes para cada conta. Muitos sites permitem que os usuários escolham um nome de usuário para que possam personalizar suas configurações ou configurar uma conta online. Por exemplo, seu banco pode permitir que você escolha um nome de usuário para acessar suas informações bancárias. Você pode precisar escolher um nome de usuário para postar mensagens em um determinado quadro de mensagens na web. Os serviços de e-mail, como o Hotmail, exigem que os usuários escolham um nome de usuário para usar o serviço. + + +Um nome de usuário geralmente é pareado com uma senha. Essa combinação de nome de usuário / senha é conhecida como login e geralmente é necessária para que os usuários façam login em sites. Por exemplo, para acessar seu e-mail pela Web, é necessário inserir seu nome de usuário e senha. Depois de fazer o login, seu nome de usuário pode aparecer na tela, mas sua senha é mantida em segredo. Ao manter sua senha privada, as pessoas podem criar contas seguras para vários sites. A maioria dos nomes de usuário pode conter letras e números, mas não espaços. Quando você escolhe um nome de usuário para uma conta de e-mail, a parte antes de "@" é o seu nome de usuário. From e6e3f00a44cc5bd70e21ca1f20fe81c13c3eefa3 Mon Sep 17 00:00:00 2001 From: ganeshniyer Date: Tue, 30 Mar 2021 21:30:49 +0530 Subject: [PATCH 069/104] Corrected a clarification based on the review removed [ and ] in the command ETCDCTL_API=3 etcdctl --endpoints=https://127.0.0.1:2379 \ --cacert= --cert= --key= \ snapshot save --- .../en/docs/tasks/administer-cluster/configure-upgrade-etcd.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/tasks/administer-cluster/configure-upgrade-etcd.md b/content/en/docs/tasks/administer-cluster/configure-upgrade-etcd.md index f626d4d1b6..ffa688e1b7 100644 --- a/content/en/docs/tasks/administer-cluster/configure-upgrade-etcd.md +++ b/content/en/docs/tasks/administer-cluster/configure-upgrade-etcd.md @@ -290,7 +290,7 @@ will list various options available from etcdctl. For example, you can take a sn the endpoint, certificates etc as shown below: ```shell -ETCDCTL_API=3 etcdctl --endpoints=https://[127.0.0.1]:2379 \ +ETCDCTL_API=3 etcdctl --endpoints=https://127.0.0.1:2379 \ --cacert= --cert= --key= \ snapshot save ``` From f98a672883538d32084979db2a0f1b6766adfcd7 Mon Sep 17 00:00:00 2001 From: Kenichi Omichi Date: Tue, 30 Mar 2021 16:58:04 +0000 Subject: [PATCH 070/104] pl: Replace redirect links of kubeadm /docs/reference/setup-tools/kubeadm/kubeadm/ is redirected to /docs/reference/setup-tools/kubeadm/ This replaces the redirect links of kubeadm with the direct links. NOTE: The pull request for `en` language has been already merged as https://github.com/kubernetes/website/pull/26919 --- content/pl/docs/reference/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/pl/docs/reference/_index.md b/content/pl/docs/reference/_index.md index d598908162..fd4ab2bff3 100644 --- a/content/pl/docs/reference/_index.md +++ b/content/pl/docs/reference/_index.md @@ -33,7 +33,7 @@ biblioteki to: * [kubectl](/docs/reference/kubectl/overview/) - Główne narzędzie tekstowe (linii poleceń) do zarządzania klastrem Kubernetes. * [JSONPath](/docs/reference/kubectl/jsonpath/) - Podręcznik składni [wyrażeń JSONPath](https://goessner.net/articles/JsonPath/) dla kubectl. -* [kubeadm](/docs/reference/setup-tools/kubeadm/kubeadm/) - Narzędzie tekstowe do łatwego budowania klastra Kubernetes spełniającego niezbędne wymogi bezpieczeństwa. +* [kubeadm](/docs/reference/setup-tools/kubeadm/) - Narzędzie tekstowe do łatwego budowania klastra Kubernetes spełniającego niezbędne wymogi bezpieczeństwa. ## Dokumentacja komponentów From 39c82936d90119c88b6a69354c55b21530f2b694 Mon Sep 17 00:00:00 2001 From: seokho-son Date: Sat, 27 Mar 2021 18:34:09 +0900 Subject: [PATCH 071/104] Update outdated files in dev-1.20-ko.7 (p2) --- .../configure-redis-using-configmap.md | 251 ++++++++++++++---- .../expose/expose-intro.html | 2 +- .../expose-external-ip-address.md | 2 +- .../stateless-application/guestbook.md | 8 +- .../pods/config/example-redis-config.yaml | 8 + 5 files changed, 208 insertions(+), 63 deletions(-) create mode 100644 content/ko/examples/pods/config/example-redis-config.yaml diff --git a/content/ko/docs/tutorials/configuration/configure-redis-using-configmap.md b/content/ko/docs/tutorials/configuration/configure-redis-using-configmap.md index 34095ef424..c1b21d1404 100644 --- a/content/ko/docs/tutorials/configuration/configure-redis-using-configmap.md +++ b/content/ko/docs/tutorials/configuration/configure-redis-using-configmap.md @@ -1,22 +1,23 @@ --- -title: 컨피그 맵을 사용해서 Redis 설정하기 + + + +title: 컨피그맵을 사용해서 Redis 설정하기 content_type: tutorial --- -이 페이지에서는 컨피그 맵을 사용해서 Redis를 설정하는 방법에 대한 실세계 예제를 제공하고, [컨피그 맵을 사용해서 컨테이너 설정하기](/docs/tasks/configure-pod-container/configure-pod-configmap/) 태스크로 빌드를 한다. +이 페이지에서는 컨피그맵(ConfigMap)을 사용해서 Redis를 설정하는 방법에 대한 실세계 예제를 제공하고, [컨피그맵을 사용해서 컨테이너 설정하기](/docs/tasks/configure-pod-container/configure-pod-configmap/) 태스크로 빌드를 한다. ## {{% heading "objectives" %}} -* 다음을 포함하는 `kustomization.yaml` 파일을 생성한다. - * 컨피그 맵 생성자 - * 컨피그 맵을 사용하는 파드 리소스 -* `kubectl apply -k ./`를 실행하여 작업한 디렉터리를 적용한다. -* 구성이 잘 적용되었는지 확인한다. +* Redis 설정값으로 컨피그맵을 생성한다. +* 생성된 컨피그맵을 마운트하고 사용하는 Redis 파드를 생성한다. +* 설정이 잘 적용되었는지 확인한다. @@ -26,91 +27,227 @@ content_type: tutorial {{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} * 예시는 `kubectl` 1.14 이상 버전에서 동작한다. -* [컨피그 맵을 사용해서 컨테이너 설정하기](/docs/tasks/configure-pod-container/configure-pod-configmap/)를 이해한다. +* [컨피그맵을 사용해서 컨테이너 설정하기](/docs/tasks/configure-pod-container/configure-pod-configmap/)를 이해한다. -## 실세상 예제: 컨피그 맵을 사용해서 Redis 설정하기 +## 실세상 예제: 컨피그맵을 사용해서 Redis 설정하기 -아래의 단계를 통해서 컨피그 맵에 저장된 데이터를 사용해서 Redis 캐시를 설정할 수 있다. +아래 단계를 통해서, 컨피그맵에 저장된 데이터를 사용하는 Redis 캐시를 설정한다. -첫째, `redis-config` 파일에서 컨피그 맵을 포함한 `kustomization.yaml`를 생성한다. - -{{< codenew file="pods/config/redis-config" >}} +우선, 비어 있는 설정으로 컨피그맵을 생성한다. ```shell -curl -OL https://k8s.io/examples/pods/config/redis-config - -cat <./kustomization.yaml -configMapGenerator: -- name: example-redis-config - files: - - redis-config +cat <./example-redis-config.yaml +apiVersion: v1 +kind: ConfigMap +metadata: + name: example-redis-config +data: + redis-config: "" EOF ``` -`kustomization.yaml`에 파드 리소스 구성을 추가한다. +위에서 생성한 컨피그맵을 Redis 파드 매니페스트와 함께 적용한다. + +```shell +kubectl apply -f example-redis-config.yaml +kubectl apply -f https://raw.githubusercontent.com/kubernetes/website/master/content/en/examples/pods/config/redis-pod.yaml +``` + +Redis 파드 매니페스트의 내용을 검토하고 다음의 사항을 염두에 둔다. + +* `config` 라는 이름의 볼륨은 `spec.volumes[1]` 에 의해서 생성된다. +* `spec.volumes[1].items[0]` 내부의 `key` 와 `path` 는 `config` 볼륨에 `redis.conf` 라는 파일명으로 지정된 + `example-redis-config` 컨피그맵의 `redis-config` 키를 노출시킨다. +* 그리고 `config` 볼륨은 `spec.containers[0].volumeMounts[1]` 에 의해서 `/redis-master` 에 마운트된다. + +이 내용은 위의 `example-redis-config` 컨피그맵의 `data.redis-config` 내부 데이터를 파드 안에 있는 +`/redis-master/redis.conf` 파일의 내용으로 노출시키는 순효과(net effect)를 낸다. {{< codenew file="pods/config/redis-pod.yaml" >}} -```shell -curl -OL https://raw.githubusercontent.com/kubernetes/website/master/content/en/examples/pods/config/redis-pod.yaml - -cat <>./kustomization.yaml -resources: -- redis-pod.yaml -EOF -``` - -컨피그 맵과 파드 오브젝트를 생성하도록 kustomization 디렉터리를 적용한다. - -```shell -kubectl apply -k . -``` - 생성된 오브젝트를 확인한다. -```shell -> kubectl get -k . -NAME DATA AGE -configmap/example-redis-config-dgh9dg555m 1 52s -NAME READY STATUS RESTARTS AGE -pod/redis 1/1 Running 0 52s +```shell +kubectl get pod/redis configmap/example-redis-config ``` -이 예제에서는 설정 볼륨이 `/redis-master`에 마운트되어 있다. -`redis-config` 키를 `redis.conf`라는 이름의 파일에 추가하기 위해 `path`를 사용한다. -따라서, Redis 설정을 위한 파일 경로는 `/redis-master/redis.conf`이다. -이곳이 이미지가 Redis 마스터를 위한 설정 파일을 찾는 곳이다. +다음의 결과를 볼 수 있다. -설정이 올바르게 적용되었는지 확인하기 위해서, -`kubectl exec`를 사용해 파드 속에서 `redis-cli` 툴을 실행해 본다. +```shell +NAME READY STATUS RESTARTS AGE +pod/redis 1/1 Running 0 8s + +NAME DATA AGE +configmap/example-redis-config 1 14s +``` + +`example-redis-config` 컨피그맵의 `redis-config` 키를 공란으로 둔 것을 기억하자. + +```shell +kubectl describe configmap/example-redis-config +``` + +`redis-config` 키가 비어 있는 것을 확인할 수 있다. + +```shell +Name: example-redis-config +Namespace: default +Labels: +Annotations: + +Data +==== +redis-config: +``` + +`kubectl exec` 를 사용하여 파드에 접속하고, 현재 설정 확인을 위해서 `redis-cli` 도구를 실행한다. ```shell kubectl exec -it redis -- redis-cli +``` + +`maxmemory` 를 확인한다. + +```shell 127.0.0.1:6379> CONFIG GET maxmemory +``` + +기본값인 0을 볼 수 있을 것이다. + +```shell +1) "maxmemory" +2) "0" +``` + +유사하게, `maxmemory-policy` 를 확인한다. + +```shell +127.0.0.1:6379> CONFIG GET maxmemory-policy +``` + +이것도 기본값인 `noeviction` 을 보여줄 것이다. + +```shell +1) "maxmemory-policy" +2) "noeviction" +``` + +이제 `example-redis-config` 컨피그맵에 몇 가지 설정값을 추가해 본다. + +{{< codenew file="pods/config/example-redis-config.yaml" >}} + +갱신된 컨피그맵을 적용한다. + +```shell +kubectl apply -f example-redis-config.yaml +``` + +컨피그맵이 갱신된 것을 확인한다. + +```shell +kubectl describe configmap/example-redis-config +``` + +방금 추가한 설정값을 확인할 수 있을 것이다. + +```shell +Name: example-redis-config +Namespace: default +Labels: +Annotations: + +Data +==== +redis-config: +---- +maxmemory 2mb +maxmemory-policy allkeys-lru +``` + +설정이 적용되었는지 확인하려면, `kubectl exec` 를 통한 `redis-cli` 로 Redis 파드를 다시 확인한다. + +```shell +kubectl exec -it redis -- redis-cli +``` + +`maxmemory` 를 확인한다. + +```shell +127.0.0.1:6379> CONFIG GET maxmemory +``` + +기본값인 0을 볼 수 있을 것이다. + +```shell +1) "maxmemory" +2) "0" +``` + +유사하게, `maxmemory-policy` 도 기본 설정인 `noeviction` 을 보여줄 것이다. + +```shell +127.0.0.1:6379> CONFIG GET maxmemory-policy +``` + +위의 명령은 다음을 반환한다. + +```shell +1) "maxmemory-policy" +2) "noeviction" +``` + +파드는 연관된 컨피그맵에서 갱신된 값을 인지하기 위해서 재시작이 필요하므로 +해당 설정값이 변경되지 않은 상태이다. 파드를 삭제하고 다시 생성한다. + +```shell +kubectl delete pod redis +kubectl apply -f https://raw.githubusercontent.com/kubernetes/website/master/content/en/examples/pods/config/redis-pod.yaml +``` + +이제 마지막으로 설정값을 다시 확인해 본다. + +```shell +kubectl exec -it redis -- redis-cli +``` + +`maxmemory` 를 확인한다. + +```shell +127.0.0.1:6379> CONFIG GET maxmemory +``` + +이것은 이제 갱신된 값인 2097152를 반환한다. + +```shell 1) "maxmemory" 2) "2097152" +``` + +유사하게, `maxmemory-policy` 도 갱신되어 있다. + +```shell 127.0.0.1:6379> CONFIG GET maxmemory-policy +``` + +이것은 원하는 값인 `allkeys-lru` 를 반환한다. + +```shell 1) "maxmemory-policy" 2) "allkeys-lru" ``` -생성된 파드를 삭제한다. +생성된 자원을 삭제하여 작업을 정리한다. + ```shell -kubectl delete pod redis +kubectl delete pod/redis configmap/example-redis-config ``` - - ## {{% heading "whatsnext" %}} -* [컨피그 맵](/docs/tasks/configure-pod-container/configure-pod-configmap/) 배우기. - - - - +* [컨피그맵](/docs/tasks/configure-pod-container/configure-pod-configmap/) 배우기. diff --git a/content/ko/docs/tutorials/kubernetes-basics/expose/expose-intro.html b/content/ko/docs/tutorials/kubernetes-basics/expose/expose-intro.html index e44e68df85..aac6298a7a 100644 --- a/content/ko/docs/tutorials/kubernetes-basics/expose/expose-intro.html +++ b/content/ko/docs/tutorials/kubernetes-basics/expose/expose-intro.html @@ -37,7 +37,7 @@ weight: 10

  • ClusterIP (기본값) - 클러스터 내에서 내부 IP 에 대해 서비스를 노출해준다. 이 방식은 오직 클러스터 내에서만 서비스가 접근될 수 있도록 해준다.
  • NodePort - NAT가 이용되는 클러스터 내에서 각각 선택된 노드들의 동일한 포트에 서비스를 노출시켜준다. <NodeIP>:<NodePort>를 이용하여 클러스터 외부로부터 서비스가 접근할 수 있도록 해준다. ClusterIP의 상위 집합이다.
  • LoadBalancer - (지원 가능한 경우) 기존 클라우드에서 외부용 로드밸런서를 생성하고 서비스에 고정된 공인 IP를 할당해준다. NodePort의 상위 집합이다.
  • -
  • ExternalName - 이름으로 CNAME 레코드를 반환함으로써 임의의 이름(스펙에서 externalName으로 명시)을 이용하여 서비스를 노출시켜준다. 프록시는 사용되지 않는다. 이 방식은 kube-dns 버전 1.7 이상에서 지원 가능하다.
  • +
  • ExternalName - CNAME 레코드 및 값을 반환함으로써 서비스를 externalName 필드의 내용(예를 들면, `foo.bar.example.com`)에 매핑한다. 어떠한 종류의 프록시도 설정되지 않는다. 이 방식은 kube-dns v1.7 이상 또는 CoreDNS 버전 0.0.8 이상을 필요로 한다.
  • 다른 서비스 타입들에 대한 추가 정보는 소스 IP 이용하기 튜토리얼에서 확인 가능하다. 또한 서비스들로 애플리케이션에 접속하기도 참고해 보자.

    부가적으로, spec에 selector를 정의하지 않고 말아넣은 서비스들의 몇 가지 유즈케이스들이 있음을 주의하자. selector 없이 생성된 서비스는 상응하는 엔드포인트 오브젝트들 또한 생성하지 않는다. 이로써 사용자들로 하여금 하나의 서비스를 특정한 엔드포인트에 매핑 시킬수 있도록 해준다. selector를 생략하게 되는 또 다른 가능성은 여러분이 type: ExternalName을 이용하겠다고 확고하게 의도하는 경우이다.

    diff --git a/content/ko/docs/tutorials/stateless-application/expose-external-ip-address.md b/content/ko/docs/tutorials/stateless-application/expose-external-ip-address.md index a8a2c0653a..2b8ffff7ff 100644 --- a/content/ko/docs/tutorials/stateless-application/expose-external-ip-address.md +++ b/content/ko/docs/tutorials/stateless-application/expose-external-ip-address.md @@ -11,7 +11,7 @@ weight: 10 ## {{% heading "prerequisites" %}} - * [kubectl](/ko/docs/tasks/tools/install-kubectl/)을 설치한다. + * [kubectl](/ko/docs/tasks/tools/)을 설치한다. * Google Kubernetes Engine 또는 Amazon Web Services와 같은 클라우드 공급자를 사용하여 쿠버네티스 클러스터를 생성한다. 이 튜토리얼은 [외부 로드 밸런서](/docs/tasks/access-application-cluster/create-external-load-balancer/)를 생성하는데, diff --git a/content/ko/docs/tutorials/stateless-application/guestbook.md b/content/ko/docs/tutorials/stateless-application/guestbook.md index 24e05ab77f..04230b4f3e 100644 --- a/content/ko/docs/tutorials/stateless-application/guestbook.md +++ b/content/ko/docs/tutorials/stateless-application/guestbook.md @@ -1,5 +1,7 @@ --- title: "예시: MongoDB를 사용한 PHP 방명록 애플리케이션 배포하기" + + content_type: tutorial weight: 20 card: @@ -15,8 +17,6 @@ min-kubernetes-server-version: v1.14 * 방명록을 저장하는 단일 인스턴스 [MongoDB](https://www.mongodb.com/) * 여러 개의 웹 프론트엔드 인스턴스 - - ## {{% heading "objectives" %}} * Mongo 데이터베이스를 시작 @@ -87,6 +87,7 @@ kubectl apply -f ./content/en/examples/application/guestbook/mongo-deployment.ya ```shell kubectl apply -f https://k8s.io/examples/application/guestbook/mongo-service.yaml ``` + 2. 使用静态控制平面 Pod 清单来构造一组 DaemonSet 清单,这些清单将运行自托管的控制平面。 - 它还会在必要时修改这些清单,例如添加新的秘密卷。 + 它还会在必要时修改这些清单,例如添加新的 secrets 卷。 -启动引导令牌被定义成一个特定类型的 Secret (`bootstrap.kubernetes.io/token`), +启动引导令牌被定义成一个特定类型的 Secret(`bootstrap.kubernetes.io/token`), 并存在于 `kube-system` 名字空间中。 这些 Secret 会被 API 服务器上的启动引导认证组件(Bootstrap Authenticator)读取。 控制器管理器中的控制器 TokenCleaner 能够删除过期的令牌。 @@ -66,9 +66,9 @@ only be shared with trusted parties. 启动引导令牌使用 `abcdef.0123456789abcdef` 的形式。 更加规范地说,它们必须符合正则表达式 `[a-z0-9]{6}\.[a-z0-9]{16}`。 -令牌的第一部分是 "Token ID",它是一种公开信息,用于引用令牌并确保不会 +令牌的第一部分是 “Token ID”,它是一种公开信息,用于引用令牌并确保不会 泄露认证所使用的秘密信息。 -第二部分是"令牌秘密(Token Secret)",它应该被共享给受信的第三方。 +第二部分是“令牌秘密(Token Secret)”,它应该被共享给受信的第三方。 ## 启用启动引导令牌 @@ -275,7 +275,7 @@ verify the JWS using the `HS256` scheme (HMAC-SHA256) with the full token (e.g. `07401b.f395accd246ae52d`) as the shared secret. Users _must_ verify that HS256 is used. --> -签名是一个使用 "detached" 模式生成的 JWS 签名。 +签名是一个使用 “detached” 模式生成的 JWS 签名。 为了检验签名,用户应该按照 JWS 规则(base64 编码且丢掉结尾的 `=`)对 `kubeconfig` 的载荷进行编码。完成编码的载荷会被插入到两个句点中间,形成完整的 JWS。你可以使用完整的令牌(比如 `07401b.f395accd246ae52d`)作为共享密钥, From c72828aadf385718e4a3886d92cfcc1b6718126d Mon Sep 17 00:00:00 2001 From: Arhell Date: Thu, 1 Apr 2021 01:28:21 +0300 Subject: [PATCH 079/104] fix bind-address on scheduler --- .../production-environment/tools/kubeadm/control-plane-flags.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/fr/docs/setup/production-environment/tools/kubeadm/control-plane-flags.md b/content/fr/docs/setup/production-environment/tools/kubeadm/control-plane-flags.md index 746602d8b4..34ae40d7cc 100644 --- a/content/fr/docs/setup/production-environment/tools/kubeadm/control-plane-flags.md +++ b/content/fr/docs/setup/production-environment/tools/kubeadm/control-plane-flags.md @@ -81,7 +81,7 @@ metadata: name: 1.13-sample scheduler: extraArgs: - address: 0.0.0.0 + bind-address: 0.0.0.0 config: /home/johndoe/schedconfig.yaml kubeconfig: /home/johndoe/kubeconfig.yaml ``` From 0d7d7470dd22af023e64e8d278bbf22d53aacce6 Mon Sep 17 00:00:00 2001 From: Qiming Teng Date: Wed, 17 Feb 2021 20:44:43 +0800 Subject: [PATCH 080/104] Add kube-proxy config reference This is a reference for kube-proxy config generated from kubernetes-sigs/reference-docs/genref tool. More specifically, it is generated using the following command: ./genref -include kube-proxy --- .../concepts/services-networking/service.md | 13 +- content/en/docs/reference/_index.md | 13 +- .../en/docs/reference/config-api/_index.md | 5 + .../config-api/kube-proxy-config.v1alpha1.md | 537 ++++++++++++++++++ .../setup-tools/kubeadm/kubeadm-init.md | 2 +- 5 files changed, 561 insertions(+), 9 deletions(-) create mode 100644 content/en/docs/reference/config-api/_index.md create mode 100644 content/en/docs/reference/config-api/kube-proxy-config.v1alpha1.md diff --git a/content/en/docs/concepts/services-networking/service.md b/content/en/docs/concepts/services-networking/service.md index b7a7edcd38..3ac07138e0 100644 --- a/content/en/docs/concepts/services-networking/service.md +++ b/content/en/docs/concepts/services-networking/service.md @@ -513,8 +513,13 @@ allocates a port from a range specified by `--service-node-port-range` flag (def Each node proxies that port (the same port number on every Node) into your Service. Your Service reports the allocated port in its `.spec.ports[*].nodePort` field. -If you want to specify particular IP(s) to proxy the port, you can set the `--nodeport-addresses` flag in kube-proxy to particular IP block(s); this is supported since Kubernetes v1.10. -This flag takes a comma-delimited list of IP blocks (e.g. 10.0.0.0/8, 192.0.2.0/25) to specify IP address ranges that kube-proxy should consider as local to this node. +If you want to specify particular IP(s) to proxy the port, you can set the +`--nodeport-addresses` flag for kube-proxy or the equivalent `nodePortAddresses` +field of the +[kube-proxy configuration file](/docs/reference/config-api/kube-proxy-config.v1alpha1/) +to particular IP block(s). + +This flag takes a comma-delimited list of IP blocks (e.g. `10.0.0.0/8`, `192.0.2.0/25`) to specify IP address ranges that kube-proxy should consider as local to this node. For example, if you start kube-proxy with the `--nodeport-addresses=127.0.0.0/8` flag, kube-proxy only selects the loopback interface for NodePort Services. The default for `--nodeport-addresses` is an empty list. This means that kube-proxy should consider all available network interfaces for NodePort. (That's also compatible with earlier Kubernetes releases). @@ -530,7 +535,9 @@ to configure environments that are not fully supported by Kubernetes, or even to just expose one or more nodes' IPs directly. Note that this Service is visible as `:spec.ports[*].nodePort` -and `.spec.clusterIP:spec.ports[*].port`. (If the `--nodeport-addresses` flag in kube-proxy is set, would be filtered NodeIP(s).) +and `.spec.clusterIP:spec.ports[*].port`. +If the `--nodeport-addresses` flag for kube-proxy or the equivalent field +in the kube-proxy configuration file is set, `` would be filtered node IP(s). For example: diff --git a/content/en/docs/reference/_index.md b/content/en/docs/reference/_index.md index a261b8a947..00adcad7d7 100644 --- a/content/en/docs/reference/_index.md +++ b/content/en/docs/reference/_index.md @@ -54,14 +54,17 @@ client libraries: * [kubelet](/docs/reference/command-line-tools-reference/kubelet/) - The primary *node agent* that runs on each node. The kubelet takes a set of PodSpecs and ensures that the described containers are running and healthy. * [kube-apiserver](/docs/reference/command-line-tools-reference/kube-apiserver/) - REST API that validates and configures data for API objects such as pods, services, replication controllers. * [kube-controller-manager](/docs/reference/command-line-tools-reference/kube-controller-manager/) - Daemon that embeds the core control loops shipped with Kubernetes. -* [kube-proxy](/docs/reference/command-line-tools-reference/kube-proxy/) - Can do simple TCP/UDP stream forwarding or round-robin TCP/UDP forwarding across a set of back-ends. -* [kube-scheduler](/docs/reference/command-line-tools-reference/kube-scheduler/) - Scheduler that manages availability, performance, and capacity. +* [kube-proxy](/docs/reference/command-line-tools-reference/kube-proxy/) - Can + do simple TCP/UDP stream forwarding or round-robin TCP/UDP forwarding across + a set of back-ends. +* [kube-scheduler](/docs/reference/command-line-tools-reference/kube-scheduler/) - Scheduler that manages availability, performance, and capacity. -## Scheduling + * [Scheduler Policies](/docs/reference/scheduling/policies) + * [Scheduler Profiles](/docs/reference/scheduling/config#profiles) -* [Scheduler Policies](/docs/reference/scheduling/policies) -* [Scheduler Profiles](/docs/reference/scheduling/config#profiles) +## Config APIs +* [kube-proxy configuration (v1alpha1)](/docs/reference/config-api/kube-proxy-config.v1alpha1/) ## Design Docs diff --git a/content/en/docs/reference/config-api/_index.md b/content/en/docs/reference/config-api/_index.md new file mode 100644 index 0000000000..a053b77d60 --- /dev/null +++ b/content/en/docs/reference/config-api/_index.md @@ -0,0 +1,5 @@ +--- +title: Configuration APIs +weight: 65 +--- + diff --git a/content/en/docs/reference/config-api/kube-proxy-config.v1alpha1.md b/content/en/docs/reference/config-api/kube-proxy-config.v1alpha1.md new file mode 100644 index 0000000000..e66bcd7443 --- /dev/null +++ b/content/en/docs/reference/config-api/kube-proxy-config.v1alpha1.md @@ -0,0 +1,537 @@ +--- +title: kube-proxy Configuration (v1alpha1) +content_type: tool-reference +package: kubeproxy.config.k8s.io/v1alpha1 +auto_generated: true +--- + + +## Resource Types + + + +- [KubeProxyConfiguration](#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration) + + + + +## `KubeProxyConfiguration` {#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration} + + + + + +KubeProxyConfiguration contains everything necessary to configure the +Kubernetes proxy server. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    kubeproxy.config.k8s.io/v1alpha1
    kind
    string
    KubeProxyConfiguration
    featureGates [Required]
    +map[string]bool +
    + featureGates is a map of feature names to bools that enable or disable alpha/experimental features.
    bindAddress [Required]
    +string +
    + bindAddress is the IP address for the proxy server to serve on (set to 0.0.0.0 +for all interfaces)
    healthzBindAddress [Required]
    +string +
    + healthzBindAddress is the IP address and port for the health check server to serve on, +defaulting to 0.0.0.0:10256
    metricsBindAddress [Required]
    +string +
    + metricsBindAddress is the IP address and port for the metrics server to serve on, +defaulting to 127.0.0.1:10249 (set to 0.0.0.0 for all interfaces)
    bindAddressHardFail [Required]
    +bool +
    + bindAddressHardFail, if true, kube-proxy will treat failure to bind to a port as fatal and exit
    enableProfiling [Required]
    +bool +
    + enableProfiling enables profiling via web interface on /debug/pprof handler. +Profiling handlers will be handled by metrics server.
    clusterCIDR [Required]
    +string +
    + clusterCIDR is the CIDR range of the pods in the cluster. It is used to +bridge traffic coming from outside of the cluster. If not provided, +no off-cluster bridging will be performed.
    hostnameOverride [Required]
    +string +
    + hostnameOverride, if non-empty, will be used as the identity instead of the actual hostname.
    clientConnection [Required]
    +ClientConnectionConfiguration +
    + clientConnection specifies the kubeconfig file and client connection settings for the proxy +server to use when communicating with the apiserver.
    iptables [Required]
    +KubeProxyIPTablesConfiguration +
    + iptables contains iptables-related configuration options.
    ipvs [Required]
    +KubeProxyIPVSConfiguration +
    + ipvs contains ipvs-related configuration options.
    oomScoreAdj [Required]
    +int32 +
    + oomScoreAdj is the oom-score-adj value for kube-proxy process. Values must be within +the range [-1000, 1000]
    mode [Required]
    +ProxyMode +
    + mode specifies which proxy mode to use.
    portRange [Required]
    +string +
    + portRange is the range of host ports (beginPort-endPort, inclusive) that may be consumed +in order to proxy service traffic. If unspecified (0-0) then ports will be randomly chosen.
    udpIdleTimeout [Required]
    +meta/v1.Duration +
    + udpIdleTimeout is how long an idle UDP connection will be kept open (e.g. '250ms', '2s'). +Must be greater than 0. Only applicable for proxyMode=userspace.
    conntrack [Required]
    +KubeProxyConntrackConfiguration +
    + conntrack contains conntrack-related configuration options.
    configSyncPeriod [Required]
    +meta/v1.Duration +
    + configSyncPeriod is how often configuration from the apiserver is refreshed. Must be greater +than 0.
    nodePortAddresses [Required]
    +[]string +
    + nodePortAddresses is the --nodeport-addresses value for kube-proxy process. Values must be valid +IP blocks. These values are as a parameter to select the interfaces where nodeport works. +In case someone would like to expose a service on localhost for local visit and some other interfaces for +particular purpose, a list of IP blocks would do that. +If set it to "127.0.0.0/8", kube-proxy will only select the loopback interface for NodePort. +If set it to a non-zero IP block, kube-proxy will filter that down to just the IPs that applied to the node. +An empty string slice is meant to select all network interfaces.
    winkernel [Required]
    +KubeProxyWinkernelConfiguration +
    + winkernel contains winkernel-related configuration options.
    showHiddenMetricsForVersion [Required]
    +string +
    + ShowHiddenMetricsForVersion is the version for which you want to show hidden metrics.
    detectLocalMode [Required]
    +LocalMode +
    + DetectLocalMode determines mode to use for detecting local traffic, defaults to LocalModeClusterCIDR
    + + + +## `KubeProxyConntrackConfiguration` {#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConntrackConfiguration} + + + + +**Appears in:** + +- [KubeProxyConfiguration](#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration) + + +KubeProxyConntrackConfiguration contains conntrack settings for +the Kubernetes proxy server. + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    maxPerCore [Required]
    +int32 +
    + maxPerCore is the maximum number of NAT connections to track +per CPU core (0 to leave the limit as-is and ignore min).
    min [Required]
    +int32 +
    + min is the minimum value of connect-tracking records to allocate, +regardless of conntrackMaxPerCore (set maxPerCore=0 to leave the limit as-is).
    tcpEstablishedTimeout [Required]
    +meta/v1.Duration +
    + tcpEstablishedTimeout is how long an idle TCP connection will be kept open +(e.g. '2s'). Must be greater than 0 to set.
    tcpCloseWaitTimeout [Required]
    +meta/v1.Duration +
    + tcpCloseWaitTimeout is how long an idle conntrack entry +in CLOSE_WAIT state will remain in the conntrack +table. (e.g. '60s'). Must be greater than 0 to set.
    + + + +## `KubeProxyIPTablesConfiguration` {#kubeproxy-config-k8s-io-v1alpha1-KubeProxyIPTablesConfiguration} + + + + +**Appears in:** + +- [KubeProxyConfiguration](#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration) + + +KubeProxyIPTablesConfiguration contains iptables-related configuration +details for the Kubernetes proxy server. + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    masqueradeBit [Required]
    +int32 +
    + masqueradeBit is the bit of the iptables fwmark space to use for SNAT if using +the pure iptables proxy mode. Values must be within the range [0, 31].
    masqueradeAll [Required]
    +bool +
    + masqueradeAll tells kube-proxy to SNAT everything if using the pure iptables proxy mode.
    syncPeriod [Required]
    +meta/v1.Duration +
    + syncPeriod is the period that iptables rules are refreshed (e.g. '5s', '1m', +'2h22m'). Must be greater than 0.
    minSyncPeriod [Required]
    +meta/v1.Duration +
    + minSyncPeriod is the minimum period that iptables rules are refreshed (e.g. '5s', '1m', +'2h22m').
    + + + +## `KubeProxyIPVSConfiguration` {#kubeproxy-config-k8s-io-v1alpha1-KubeProxyIPVSConfiguration} + + + + +**Appears in:** + +- [KubeProxyConfiguration](#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration) + + +KubeProxyIPVSConfiguration contains ipvs-related configuration +details for the Kubernetes proxy server. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    syncPeriod [Required]
    +meta/v1.Duration +
    + syncPeriod is the period that ipvs rules are refreshed (e.g. '5s', '1m', +'2h22m'). Must be greater than 0.
    minSyncPeriod [Required]
    +meta/v1.Duration +
    + minSyncPeriod is the minimum period that ipvs rules are refreshed (e.g. '5s', '1m', +'2h22m').
    scheduler [Required]
    +string +
    + ipvs scheduler
    excludeCIDRs [Required]
    +[]string +
    + excludeCIDRs is a list of CIDR's which the ipvs proxier should not touch +when cleaning up ipvs services.
    strictARP [Required]
    +bool +
    + strict ARP configure arp_ignore and arp_announce to avoid answering ARP queries +from kube-ipvs0 interface
    tcpTimeout [Required]
    +meta/v1.Duration +
    + tcpTimeout is the timeout value used for idle IPVS TCP sessions. +The default value is 0, which preserves the current timeout value on the system.
    tcpFinTimeout [Required]
    +meta/v1.Duration +
    + tcpFinTimeout is the timeout value used for IPVS TCP sessions after receiving a FIN. +The default value is 0, which preserves the current timeout value on the system.
    udpTimeout [Required]
    +meta/v1.Duration +
    + udpTimeout is the timeout value used for IPVS UDP packets. +The default value is 0, which preserves the current timeout value on the system.
    + + + +## `KubeProxyWinkernelConfiguration` {#kubeproxy-config-k8s-io-v1alpha1-KubeProxyWinkernelConfiguration} + + + + +**Appears in:** + +- [KubeProxyConfiguration](#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration) + + +KubeProxyWinkernelConfiguration contains Windows/HNS settings for +the Kubernetes proxy server. + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    networkName [Required]
    +string +
    + networkName is the name of the network kube-proxy will use +to create endpoints and policies
    sourceVip [Required]
    +string +
    + sourceVip is the IP address of the source VIP endoint used for +NAT when loadbalancing
    enableDSR [Required]
    +bool +
    + enableDSR tells kube-proxy whether HNS policies should be created +with DSR
    + + + +## `LocalMode` {#kubeproxy-config-k8s-io-v1alpha1-LocalMode} + +(Alias of `string`) + + +**Appears in:** + +- [KubeProxyConfiguration](#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration) + + +LocalMode represents modes to detect local traffic from the node + + + + + +## `ProxyMode` {#kubeproxy-config-k8s-io-v1alpha1-ProxyMode} + +(Alias of `string`) + + +**Appears in:** + +- [KubeProxyConfiguration](#kubeproxy-config-k8s-io-v1alpha1-KubeProxyConfiguration) + + +ProxyMode represents modes used by the Kubernetes proxy server. + +Currently, three modes of proxy are available in Linux platform: 'userspace' (older, going to be EOL), 'iptables' +(newer, faster), 'ipvs'(newest, better in performance and scalability). + +Two modes of proxy are available in Windows platform: 'userspace'(older, stable) and 'kernelspace' (newer, faster). + +In Linux platform, if proxy mode is blank, use the best-available proxy (currently iptables, but may change in the +future). If the iptables proxy is selected, regardless of how, but the system's kernel or iptables versions are +insufficient, this always falls back to the userspace proxy. IPVS mode will be enabled when proxy mode is set to 'ipvs', +and the fall back path is firstly iptables and then userspace. + +In Windows platform, if proxy mode is blank, use the best-available proxy (currently userspace, but may change in the +future). If winkernel proxy is selected, regardless of how, but the Windows kernel can't support this mode of proxy, +this always falls back to the userspace proxy. + + + + diff --git a/content/en/docs/reference/setup-tools/kubeadm/kubeadm-init.md b/content/en/docs/reference/setup-tools/kubeadm/kubeadm-init.md index 3d4b977102..96a7b17a4e 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/kubeadm-init.md +++ b/content/en/docs/reference/setup-tools/kubeadm/kubeadm-init.md @@ -130,7 +130,7 @@ page and pick a version from [the list](https://godoc.org/k8s.io/kubernetes/cmd/ ### Adding kube-proxy parameters {#kube-proxy} For information about kube-proxy parameters in the kubeadm configuration see: -- [kube-proxy](https://godoc.org/k8s.io/kubernetes/pkg/proxy/apis/config#KubeProxyConfiguration) +- [kube-proxy reference](/docs/reference/config-api/kube-proxy-config.v1alpha1/) For information about enabling IPVS mode with kubeadm see: - [IPVS](https://github.com/kubernetes/kubernetes/blob/master/pkg/proxy/ipvs/README.md) From d5b17933516c9a194f1497e76c0d61238097d6b2 Mon Sep 17 00:00:00 2001 From: Jailton Lopes Date: Thu, 1 Apr 2021 00:42:41 -0300 Subject: [PATCH 081/104] Update "Deploying PHP Guestbook application with MongoDB" Tutorial to fix the following issues: * #26765 - Ordered lists with wrong indexes * The wrong output of "kubectl get service frontend" on LoadBalancer Service Type example. * Fixing format Signed-off-by: Jailton Lopes --- .../stateless-application/guestbook.md | 49 ++++++++++--------- 1 file changed, 25 insertions(+), 24 deletions(-) diff --git a/content/en/docs/tutorials/stateless-application/guestbook.md b/content/en/docs/tutorials/stateless-application/guestbook.md index 36772253f6..d21e60dde8 100644 --- a/content/en/docs/tutorials/stateless-application/guestbook.md +++ b/content/en/docs/tutorials/stateless-application/guestbook.md @@ -49,13 +49,14 @@ The manifest file, included below, specifies a Deployment controller that runs a 1. Launch a terminal window in the directory you downloaded the manifest files. 1. Apply the MongoDB Deployment from the `mongo-deployment.yaml` file: + + ```shell kubectl apply -f https://k8s.io/examples/application/guestbook/mongo-deployment.yaml ``` - 1. Query the list of Pods to verify that the MongoDB Pod is running: @@ -84,15 +85,15 @@ The guestbook application needs to communicate to the MongoDB to write its data. 1. Apply the MongoDB Service from the following `mongo-service.yaml` file: + + ```shell kubectl apply -f https://k8s.io/examples/application/guestbook/mongo-service.yaml ``` - - 1. Query the list of Services to verify that the MongoDB Service is running: ```shell @@ -122,15 +123,15 @@ The guestbook application has a web frontend serving the HTTP requests written i 1. Apply the frontend Deployment from the `frontend-deployment.yaml` file: + + ```shell kubectl apply -f https://k8s.io/examples/application/guestbook/frontend-deployment.yaml ``` - - 1. Query the list of Pods to verify that the three frontend replicas are running: ```shell @@ -160,15 +161,15 @@ Some cloud providers, like Google Compute Engine or Google Kubernetes Engine, su 1. Apply the frontend Service from the `frontend-service.yaml` file: + + ```shell kubectl apply -f https://k8s.io/examples/application/guestbook/frontend-service.yaml ``` - - 1. Query the list of Services to verify that the frontend Service is running: ```shell @@ -179,7 +180,7 @@ kubectl apply -f ./content/en/examples/application/guestbook/frontend-service.ya ``` NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE - frontend ClusterIP 10.0.0.112 80/TCP 6s + frontend ClusterIP 10.0.0.112 80/TCP 6s kubernetes ClusterIP 10.0.0.1 443/TCP 4m mongo ClusterIP 10.0.0.151 6379/TCP 2m ``` @@ -214,8 +215,8 @@ If you deployed the `frontend-service.yaml` manifest with type: `LoadBalancer` y The response should be similar to this: ``` - NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE - frontend ClusterIP 10.51.242.136 109.197.92.229 80:32372/TCP 1m + NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE + frontend LoadBalancer 10.51.242.136 109.197.92.229 80:32372/TCP 1m ``` 1. Copy the external IP address, and load the page in your browser to view your guestbook. @@ -245,7 +246,7 @@ You can scale up or down as needed because your servers are defined as a Service frontend-3823415956-k22zn 1/1 Running 0 54m frontend-3823415956-w9gbt 1/1 Running 0 54m frontend-3823415956-x2pld 1/1 Running 0 5s - mongo-1068406935-3lswp 1/1 Running 0 56m + mongo-1068406935-3lswp 1/1 Running 0 56m ``` 1. Run the following command to scale down the number of frontend Pods: @@ -266,7 +267,7 @@ You can scale up or down as needed because your servers are defined as a Service NAME READY STATUS RESTARTS AGE frontend-3823415956-k22zn 1/1 Running 0 1h frontend-3823415956-w9gbt 1/1 Running 0 1h - mongo-1068406935-3lswp 1/1 Running 0 1h + mongo-1068406935-3lswp 1/1 Running 0 1h ``` From d4597c7c24e9527cbec24a4b5579df33211f6fbf Mon Sep 17 00:00:00 2001 From: "mengjiao.liu" Date: Thu, 1 Apr 2021 11:50:40 +0800 Subject: [PATCH 082/104] [zh] sync content/en/docs/concepts/overview/components.md --- content/zh/docs/concepts/overview/components.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/content/zh/docs/concepts/overview/components.md b/content/zh/docs/concepts/overview/components.md index 090468282a..6d3c0d7281 100644 --- a/content/zh/docs/concepts/overview/components.md +++ b/content/zh/docs/concepts/overview/components.md @@ -82,18 +82,18 @@ the same machine, and do not run user containers on this machine. See {{< glossary_definition term_id="kube-controller-manager" length="all" >}} 这些控制器包括: * 节点控制器(Node Controller): 负责在节点出现故障时进行通知和响应 -* 副本控制器(Replication Controller): 负责为系统中的每个副本控制器对象维护正确数量的 Pod +* 任务控制器(Job controller): 监测代表一次性任务的 Job 对象,然后创建 Pods 来运行这些任务直至完成 * 端点控制器(Endpoints Controller): 填充端点(Endpoints)对象(即加入 Service 与 Pod) * 服务帐户和令牌控制器(Service Account & Token Controllers): 为新的命名空间创建默认帐户和 API 访问令牌 From a66fec504eb0904ceaee32bf0e72bc981b60b7ad Mon Sep 17 00:00:00 2001 From: Juan Sebastian Romero Date: Thu, 1 Apr 2021 01:04:01 -0300 Subject: [PATCH 083/104] Update kubespray.md update link to playbook variables in ansible --- content/en/docs/setup/production-environment/tools/kubespray.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/setup/production-environment/tools/kubespray.md b/content/en/docs/setup/production-environment/tools/kubespray.md index 5ba4c995dd..c4300b53a2 100644 --- a/content/en/docs/setup/production-environment/tools/kubespray.md +++ b/content/en/docs/setup/production-environment/tools/kubespray.md @@ -68,7 +68,7 @@ Kubespray provides the ability to customize many aspects of the deployment: * {{< glossary_tooltip term_id="cri-o" >}} * Certificate generation methods -Kubespray customizations can be made to a [variable file](https://docs.ansible.com/ansible/playbooks_variables.html). If you are getting started with Kubespray, consider using the Kubespray defaults to deploy your cluster and explore Kubernetes. +Kubespray customizations can be made to a [variable file](https://docs.ansible.com/ansible/latest/user_guide/playbooks_variables.html). If you are getting started with Kubespray, consider using the Kubespray defaults to deploy your cluster and explore Kubernetes. ### (4/5) Deploy a Cluster From 692e997105ff981e938b3301af05809e1f48842a Mon Sep 17 00:00:00 2001 From: "mengjiao.liu" Date: Thu, 1 Apr 2021 11:05:48 +0800 Subject: [PATCH 084/104] [zh] Sync content/en/docs/concepts/storage/persistent-volumes.md --- .../docs/concepts/storage/persistent-volumes.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/content/zh/docs/concepts/storage/persistent-volumes.md b/content/zh/docs/concepts/storage/persistent-volumes.md index 82ec637f76..1160dd0e4a 100644 --- a/content/zh/docs/concepts/storage/persistent-volumes.md +++ b/content/zh/docs/concepts/storage/persistent-volumes.md @@ -69,7 +69,7 @@ Pod 会耗用节点资源,而 PVC 申领会耗用 PV 资源。Pod 可以请求 模式之一来挂载,参见[访问模式](#access-modes))。 @@ -935,9 +935,9 @@ The following volume types support mount options: * iSCSI -Kubernetes 不对挂载选项执行合法性检查,因此非法的挂载选项只是会导致挂载失败。 +Kubernetes 不对挂载选项执行合法性检查。如果挂载选项是非法的,挂载就会失败。 +### 类型为 `hostpath` 的 PersistentVolume {#persistentvolumes-typed-hostpath} + +`hostPath` PersistentVolume 使用节点上的文件或目录来模拟网络附加(network-attached)存储。 +相关细节可参阅[`hostPath` 卷示例](/zh/docs/tasks/configure-pod-container/configure-persistent-volume-storage/#create-a-persistentvolume)。 + From b59a32dfbc0760a56b04b73c98a01a71620a7cfe Mon Sep 17 00:00:00 2001 From: "Yuk, Yongsu" Date: Wed, 24 Mar 2021 23:13:00 +0900 Subject: [PATCH 085/104] Update to Outdated files in the dev-1.20-ko.7 branch part. 1. --- .../control-plane-node-communication.md | 2 +- .../ko/docs/concepts/architecture/nodes.md | 46 +-- .../manage-deployment.md | 2 +- .../docs/concepts/configuration/configmap.md | 4 +- .../docs/concepts/configuration/overview.md | 6 +- content/ko/docs/concepts/containers/images.md | 26 +- .../concepts/extend-kubernetes/operator.md | 21 +- .../scheduling-eviction/assign-pod-node.md | 2 +- .../resource-bin-packing.md | 2 +- .../concepts/storage/dynamic-provisioning.md | 4 +- content/ko/docs/concepts/storage/volumes.md | 3 +- .../workloads/controllers/deployment.md | 4 +- content/ko/docs/reference/_index.md | 22 +- .../reference/access-authn-authz/_index.md | 2 +- .../command-line-tools-reference/_index.md | 2 +- .../feature-gates.md | 1 + .../kube-proxy.md | 103 ++--- content/ko/docs/reference/glossary/index.md | 2 +- .../docs/reference/issues-security/_index.md | 2 +- content/ko/docs/reference/kubectl/_index.md | 2 +- content/ko/docs/reference/kubectl/overview.md | 2 +- .../ko/docs/reference/scheduling/config.md | 2 - .../ko/docs/reference/setup-tools/_index.md | 2 +- .../reference/{tools.md => tools/_index.md} | 0 content/ko/docs/reference/using-api/_index.md | 3 +- .../docs/setup/best-practices/certificates.md | 6 +- .../setup/best-practices/multiple-zones.md | 2 +- .../container-runtimes.md | 353 ++++-------------- .../production-environment/tools/kops.md | 2 +- .../tools/kubeadm/install-kubeadm.md | 40 +- .../production-environment/tools/kubespray.md | 2 +- .../windows/intro-windows-in-kubernetes.md | 6 +- content/ko/docs/setup/release/notes.md | 2 +- .../administer-cluster/access-cluster-api.md | 2 +- .../kubeadm/kubeadm-certs.md | 31 +- .../declarative-config.md | 2 +- .../imperative-command.md | 2 +- .../imperative-config.md | 2 +- .../kustomization.md | 2 +- .../docs/tasks/tools/install-kubectl-linux.md | 53 ++- .../docs/tasks/tools/install-kubectl-macos.md | 4 +- 41 files changed, 320 insertions(+), 458 deletions(-) rename content/ko/docs/reference/{tools.md => tools/_index.md} (100%) diff --git a/content/ko/docs/concepts/architecture/control-plane-node-communication.md b/content/ko/docs/concepts/architecture/control-plane-node-communication.md index 36ece0d6d2..1831692bdf 100644 --- a/content/ko/docs/concepts/architecture/control-plane-node-communication.md +++ b/content/ko/docs/concepts/architecture/control-plane-node-communication.md @@ -21,7 +21,7 @@ aliases: 노드는 유효한 클라이언트 자격 증명과 함께 API 서버에 안전하게 연결할 수 있도록 클러스터에 대한 공개 루트 인증서로 프로비전해야 한다. 예를 들어, 기본 GKE 배포에서, kubelet에 제공되는 클라이언트 자격 증명은 클라이언트 인증서 형식이다. kubelet 클라이언트 인증서의 자동 프로비저닝은 [kubelet TLS 부트스트랩](/docs/reference/command-line-tools-reference/kubelet-tls-bootstrapping/)을 참고한다. API 서버에 연결하려는 파드는 쿠버네티스가 공개 루트 인증서와 유효한 베어러 토큰(bearer token)을 파드가 인스턴스화될 때 파드에 자동으로 주입하도록 서비스 어카운트를 활용하여 안전하게 연결할 수 있다. -`kubernetes` 서비스(모든 네임스페이스의)는 API 서버의 HTTPS 엔드포인트로 리디렉션되는 가상 IP 주소(kube-proxy를 통해)로 구성되어 있다. +`kubernetes` 서비스(`default` 네임스페이스의)는 API 서버의 HTTPS 엔드포인트로 리디렉션되는 가상 IP 주소(kube-proxy를 통해)로 구성되어 있다. 컨트롤 플레인 컴포넌트는 보안 포트를 통해 클러스터 API 서버와도 통신한다. diff --git a/content/ko/docs/concepts/architecture/nodes.md b/content/ko/docs/concepts/architecture/nodes.md index 4ad2a7aaaa..cb65b2832a 100644 --- a/content/ko/docs/concepts/architecture/nodes.md +++ b/content/ko/docs/concepts/architecture/nodes.md @@ -27,7 +27,7 @@ weight: 10 {{< glossary_tooltip text="API 서버" term_id="kube-apiserver" >}}에 노드를 추가하는 두가지 주요 방법이 있다. 1. 노드의 kubelet으로 컨트롤 플레인에 자체 등록 -2. 사용자 또는 다른 사용자가 노드 오브젝트를 수동으로 추가 +2. 사용자(또는 다른 사용자)가 노드 오브젝트를 수동으로 추가 노드 오브젝트 또는 노드의 kubelet으로 자체 등록한 후 컨트롤 플레인은 새 노드 오브젝트가 유효한지 확인한다. @@ -48,8 +48,8 @@ weight: 10 쿠버네티스는 내부적으로 노드 오브젝트를 생성한다(표시한다). 쿠버네티스는 kubelet이 노드의 `metadata.name` 필드와 일치하는 API 서버에 등록이 되어있는지 확인한다. -노드가 정상이면(필요한 모든 서비스가 실행중인 경우) 파드를 실행할 수 있게 된다. -그렇지 않으면, 해당 노드는 정상이 될때까지 모든 클러스터 활동에 +노드가 정상이면(예를 들어 필요한 모든 서비스가 실행중인 경우) 파드를 실행할 수 있게 된다. +그렇지 않으면, 해당 노드는 정상이 될 때까지 모든 클러스터 활동에 대해 무시된다. {{< note >}} @@ -226,13 +226,14 @@ apiserver로부터 삭제되어 그 이름을 사용할 수 있는 결과를 낳 노드 컨트롤러는 노드 리스트로부터 그 노드를 삭제한다. 세 번째는 노드의 동작 상태를 모니터링 하는 것이다. 노드 컨트롤러는 -노드가 접근 불가할 경우 (즉 노드 컨트롤러가 어떠한 사유로 하트비트 -수신을 중지하는 경우, 예를 들어 노드 다운과 같은 경우이다.) -NodeStatus의 NodeReady 컨디션을 ConditionUnknown으로 업데이트 하는 책임을 지고, -노드가 계속 접근 불가할 경우 나중에 노드로부터 (정상적인 종료를 이용하여) 모든 파드를 축출시킨다. -(ConditionUnknown을 알리기 시작하는 기본 타임아웃 값은 40초 이고, -파드를 축출하기 시작하는 값은 5분이다.) 노드 컨트롤러는 -매 `--node-monitor-period` 초 마다 각 노드의 상태를 체크한다. +다음을 담당한다. +- 노드 다운과 같은 어떤 이유로 노드 컨트롤러가 + 하트비트 수신이 중단되는 경우 NodeStatus의 NodeReady + 컨디션을 ConditionUnknown으로 업데이트 한다. +- 노드가 계속 접근 불가할 경우 나중에 노드로부터 정상적인 종료를 이용해서 모든 파드를 축출 한다. + ConditionUnknown을 알리기 시작하는 기본 타임아웃 값은 40초 이고, + 파드를 축출하기 시작하는 값은 5분이다. +노드 컨트롤러는 매 `--node-monitor-period` 초 마다 각 노드의 상태를 체크한다. #### 하트비트 @@ -250,11 +251,12 @@ kubelet은 `NodeStatus` 와 리스 오브젝트를 생성하고 업데이트 할 - kubelet은 상태가 변경되거나 구성된 상태에 대한 업데이트가 없는 경우, `NodeStatus` 를 업데이트 한다. `NodeStatus` 의 기본 업데이트 - 주기는 5분이다(연결할 수 없는 노드의 시간 제한인 40초 - 보다 훨씬 길다). + 주기는 5분으로, 연결할 수 없는 노드의 시간 제한인 40초 + 보다 훨씬 길다. - kubelet은 10초마다 리스 오브젝트를 생성하고 업데이트 한다(기본 업데이트 주기). 리스 업데이트는 `NodeStatus` 업데이트와는 - 독립적으로 발생한다. 리스 업데이트가 실패하면 kubelet에 의해 재시도하며 7초로 제한된 지수 백오프를 200 밀리초에서 부터 시작한다. + 독립적으로 발생한다. 리스 업데이트가 실패하면 kubelet에 의해 재시도하며 + 7초로 제한된 지수 백오프를 200 밀리초에서 부터 시작한다. #### 안정성 @@ -264,13 +266,13 @@ kubelet은 `NodeStatus` 와 리스 오브젝트를 생성하고 업데이트 할 노드 축출 행위는 주어진 가용성 영역 내 하나의 노드가 상태가 불량할 경우 변화한다. 노드 컨트롤러는 영역 내 동시에 상태가 불량한 노드의 퍼센티지가 얼마나 되는지 -체크한다(NodeReady 컨디션은 ConditionUnknown 또는 ConditionFalse 다.). -상태가 불량한 노드의 일부가 최소 -`--unhealthy-zone-threshold` 기본값 0.55) 가 -되면 축출 비율은 감소한다. 클러스터가 작으면 (즉 -`--large-cluster-size-threshold` 노드 이하면 - 기본값 50) 축출은 중지되고, -그렇지 않으면 축출 비율은 초당 -`--secondary-node-eviction-rate`(기본값 0.01)로 감소된다. +체크한다(NodeReady 컨디션은 ConditionUnknown 또는 +ConditionFalse 다.). +- 상태가 불량한 노드의 일부가 최소 `--unhealthy-zone-threshold` + (기본값 0.55)가 되면 축출 비율은 감소한다. +- 클러스터가 작으면 (즉 `--large-cluster-size-threshold` + 노드 이하면 - 기본값 50) 축출은 중지되고, 그렇지 않으면 축출 비율은 초당 + `--secondary-node-eviction-rate`(기본값 0.01)로 감소된다. 이 정책들이 가용성 영역 단위로 실행되어지는 이유는 나머지가 연결되어 있는 동안 하나의 가용성 영역이 마스터로부터 분할되어 질 수도 있기 때문이다. 만약 클러스터가 여러 클라우드 제공사업자의 가용성 영역에 걸쳐 있지 않으면, @@ -299,8 +301,8 @@ kubelet은 `NodeStatus` 와 리스 오브젝트를 생성하고 업데이트 할 ### 노드 용량 -노드 오브젝트는 노드 리소스 용량에 대한 정보(예: 사용 가능한 메모리의 -양과 CPU의 수)를 추적한다. +노드 오브젝트는 노드 리소스 용량에 대한 정보: 예를 들어, 사용 가능한 메모리의 +양과 CPU의 수를 추적한다. 노드의 [자체 등록](#노드에-대한-자체-등록)은 등록하는 중에 용량을 보고한다. [수동](#수동-노드-관리)으로 노드를 추가하는 경우 추가할 때 노드의 용량 정보를 설정해야 한다. diff --git a/content/ko/docs/concepts/cluster-administration/manage-deployment.md b/content/ko/docs/concepts/cluster-administration/manage-deployment.md index 9893c76548..d61d111274 100644 --- a/content/ko/docs/concepts/cluster-administration/manage-deployment.md +++ b/content/ko/docs/concepts/cluster-administration/manage-deployment.md @@ -47,7 +47,7 @@ kubectl apply -f https://k8s.io/examples/application/nginx/ 동일한 마이크로서비스 또는 애플리케이션 티어(tier)와 관련된 리소스를 동일한 파일에 배치하고, 애플리케이션과 연관된 모든 파일을 동일한 디렉터리에 그룹화하는 것이 좋다. 애플리케이션의 티어가 DNS를 사용하여 서로 바인딩되면, 스택의 모든 컴포넌트를 함께 배포할 수 있다. -URL을 구성 소스로 지정할 수도 있다. 이는 github에 체크인된 구성 파일에서 직접 배포하는 데 편리하다. +URL을 구성 소스로 지정할 수도 있다. 이는 GitHub에 체크인된 구성 파일에서 직접 배포하는 데 편리하다. ```shell kubectl apply -f https://raw.githubusercontent.com/kubernetes/website/master/content/en/examples/application/nginx/nginx-deployment.yaml diff --git a/content/ko/docs/concepts/configuration/configmap.md b/content/ko/docs/concepts/configuration/configmap.md index 73fcf62b98..50ef8b3632 100644 --- a/content/ko/docs/concepts/configuration/configmap.md +++ b/content/ko/docs/concepts/configuration/configmap.md @@ -42,8 +42,8 @@ API [오브젝트](/ko/docs/concepts/overview/working-with-objects/kubernetes-ob `spec` 이 있는 대부분의 쿠버네티스 오브젝트와 달리, 컨피그맵에는 `data` 및 `binaryData` 필드가 있다. 이러한 필드는 키-값 쌍을 값으로 허용한다. `data` 필드와 `binaryData` 는 모두 선택 사항이다. `data` 필드는 -UTF-8 바이트 시퀀스를 포함하도록 설계되었으며 `binaryData` 필드는 바이너리 데이터를 -포함하도록 설계되었다. +UTF-8 바이트 시퀀스를 포함하도록 설계되었으며 `binaryData` 필드는 바이너리 +데이터를 base64로 인코딩된 문자열로 포함하도록 설계되었다. 컨피그맵의 이름은 유효한 [DNS 서브도메인 이름](/ko/docs/concepts/overview/working-with-objects/names/#dns-서브도메인-이름)이어야 한다. diff --git a/content/ko/docs/concepts/configuration/overview.md b/content/ko/docs/concepts/configuration/overview.md index def34dd231..17fd61c6a6 100644 --- a/content/ko/docs/concepts/configuration/overview.md +++ b/content/ko/docs/concepts/configuration/overview.md @@ -81,9 +81,9 @@ DNS 서버는 새로운 `서비스`를 위한 쿠버네티스 API를 Watch하며 - `imagePullPolicy: Always`: kubelet이 컨테이너를 시작할 때마다, kubelet은 컨테이너 이미지 레지스트리를 쿼리해서 이름을 이미지 다이제스트(digest)로 확인한다. kubelet에 정확한 다이제스트가 저장된 컨테이너 이미지가 로컬로 캐시된 경우, kubelet은 캐시된 이미지를 사용한다. 그렇지 않으면, kubelet은 확인한 다이제스트를 사용해서 이미지를 다운로드(pull)하고, 해당 이미지를 사용해서 컨테이너를 시작한다. -- `imagePullPolicy`가 생략되어 있고, 이미지 태그가 `:latest` 이거나 생략되어 있다면 `Always`가 적용된다. +- `imagePullPolicy`가 생략되어 있고, 이미지 태그가 `:latest` 이거나 생략되어 있다면 `imagePullPolicy`는 자동으로 `Always`가 적용된다. 태그 값을 변경하더라도 이 값은 `IfNotPresent`로 업데이트 되지 _않는다_. -- `imagePullPolicy`가 생략되어 있고, 이미지 태그가 존재하지만 `:latest`가 아니라면 `IfNotPresent`가 적용된다. +- `imagePullPolicy`가 생략되어 있고, 이미지 태그가 존재하지만 `:latest`가 아니라면 `imagePullPolicy`는 자동으로 `IfNotPresent`가 적용된다. 태그가 나중에 제거되거나 `:latest`로 변경되더라도 `Always`로 업데이트 되지 _않는다_. - `imagePullPolicy: Never`: 이미지가 로컬에 존재한다고 가정한다. 이미지를 풀(Pull) 하기 위해 시도하지 않는다. @@ -96,7 +96,7 @@ DNS 서버는 새로운 `서비스`를 위한 쿠버네티스 API를 Watch하며 {{< /note >}} {{< note >}} -기반이 되는 이미지 제공자의 캐시 방법은 `imagePullPolicy: Always`를 효율적으로 만든다. 예를 들어, 도커에서는 이미지가 이미 존재한다면 풀(Pull) 시도는 빠르게 진행되는데, 이는 모든 이미지 레이어가 캐시되어 있으며 이미지 다운로드가 필요하지 않기 때문이다. +레지스트리가 안정적으로 동작하는 상황에서는, `imagePullPolicy: Always`로 설정되어 있더라도 기반 이미지 관리 도구의 캐싱 정책을 통해 이미지 풀(pull) 작업의 효율성을 높일 수 있다. 예를 들어, 도커를 사용하는 경우 이미지가 이미 존재한다면 풀(Pull) 시도는 빠르게 진행되는데, 이는 모든 이미지 레이어가 캐시되어 있으며 이미지 다운로드가 필요하지 않기 때문이다. {{< /note >}} ## kubectl 사용하기 diff --git a/content/ko/docs/concepts/containers/images.md b/content/ko/docs/concepts/containers/images.md index 2f1ae4a27c..fe7aca59aa 100644 --- a/content/ko/docs/concepts/containers/images.md +++ b/content/ko/docs/concepts/containers/images.md @@ -49,16 +49,32 @@ weight: 10 ## 이미지 업데이트 -기본 풀(pull) 정책은 `IfNotPresent`이며, 이것은 -{{< glossary_tooltip text="kubelet" term_id="kubelet" >}}이 이미 -존재하는 이미지에 대한 풀을 생략하게 한다. 만약 항상 풀을 강제하고 싶다면, -다음 중 하나를 수행하면 된다. +{{< glossary_tooltip text="디플로이먼트" term_id="deployment" >}}, +{{< glossary_tooltip text="스테이트풀셋" term_id="statefulset" >}}, 파드 또는 파드 +템플릿은 포함하는 다른 오브젝트를 처음 만들 때 특별히 명시하지 않은 경우 +기본적으로 해당 파드에 있는 모든 컨테이너의 풀(pull) +정책은 `IfNotPresent`로 설정된다. 이 정책은 +{{< glossary_tooltip text="kubelet" term_id="kubelet" >}}이 이미 존재하는 +이미지에 대한 풀을 생략하게 한다. + +만약 항상 풀을 강제하고 싶다면, 다음 중 하나를 수행하면 된다. - 컨테이너의 `imagePullPolicy`를 `Always`로 설정. -- `imagePullPolicy`를 생략하고 `:latest`를 사용할 이미지의 태그로 사용. +- `imagePullPolicy`를 생략하고 `:latest`를 사용할 이미지의 태그로 사용, + 쿠버네티스는 정책을 `Always`로 설정한다. - `imagePullPolicy`와 사용할 이미지의 태그를 생략. - [AlwaysPullImages](/docs/reference/access-authn-authz/admission-controllers/#alwayspullimages) 어드미션 컨트롤러를 활성화. +{{< note >}} +컨테이너의 `imagePullPolicy` 값은 오브젝트가 처음 _created_ 일 때 항상 +설정되고 나중에 이미지 태그가 변경되더라도 업데이트되지 않는다. + +예를 들어, 태그가 `:latest`가 아닌 이미지로 디플로이먼트를 생성하고, +나중에 해당 디플로이먼트의 이미지를 `:latest` 태그로 업데이트하면 +`imagePullPolicy` 필드가 `Always` 로 변경되지 않는다. 오브젝트를 +처음 생성 한 후 모든 오브젝트의 풀 정책을 수동으로 변경해야 한다. +{{< /note >}} + `imagePullPolicy` 가 특정값 없이 정의되면, `Always` 로 설정된다. ## 이미지 인덱스가 있는 다중 아키텍처 이미지 diff --git a/content/ko/docs/concepts/extend-kubernetes/operator.md b/content/ko/docs/concepts/extend-kubernetes/operator.md index 57a4f3d9d2..21b3183b99 100644 --- a/content/ko/docs/concepts/extend-kubernetes/operator.md +++ b/content/ko/docs/concepts/extend-kubernetes/operator.md @@ -102,27 +102,28 @@ kubectl edit SampleDB/example-database # 일부 설정을 수동으로 변경하 ## 자신만의 오퍼레이터 작성 {#writing-operator} -에코시스템에 원하는 동작을 구현하는 오퍼레이터가 없다면 직접 코딩할 수 있다. -[다음 내용](#다음-내용)에서는 클라우드 네이티브 오퍼레이터를 작성하는 데 -사용할 수 있는 라이브러리 및 도구에 대한 몇 가지 링크를 -찾을 수 있다. +에코시스템에 원하는 동작을 구현하는 오퍼레이터가 없다면 +직접 코딩할 수 있다. 또한 [쿠버네티스 API의 클라이언트](/ko/docs/reference/using-api/client-libraries/) 역할을 할 수 있는 모든 언어 / 런타임을 사용하여 오퍼레이터(즉, 컨트롤러)를 구현한다. +다음은 클라우드 네이티브 오퍼레이터를 작성하는 데 사용할 수 있는 +몇 가지 라이브러리와 도구들이다. +{{% thirdparty-content %}} + +* [kubebuilder](https://book.kubebuilder.io/) 사용하기 +* [KUDO](https://kudo.dev/) (Kubernetes Universal Declarative Operator) +* 웹훅(WebHook)과 함께 [Metacontroller](https://metacontroller.app/)를 + 사용하여 직접 구현하기 +* [오퍼레이터 프레임워크](https://operatorframework.io) ## {{% heading "whatsnext" %}} * [사용자 정의 리소스](/ko/docs/concepts/extend-kubernetes/api-extension/custom-resources/)에 대해 더 알아보기 * [OperatorHub.io](https://operatorhub.io/)에서 유스케이스에 맞는 이미 만들어진 오퍼레이터 찾기 -* 기존 도구를 사용하여 자신만의 오퍼레이터를 작성해보자. 다음은 예시이다. - * [KUDO](https://kudo.dev/) (Kubernetes Universal Declarative Operator) 사용하기 - * [kubebuilder](https://book.kubebuilder.io/) 사용하기 - * 웹훅(WebHook)과 함께 [Metacontroller](https://metacontroller.app/)를 - 사용하여 직접 구현하기 - * [오퍼레이터 프레임워크](https://operatorframework.io) 사용하기 * 다른 사람들이 사용할 수 있도록 자신의 오퍼레이터를 [게시](https://operatorhub.io/)하기 * 오퍼레이터 패턴을 소개한 [CoreOS 원본 글](https://web.archive.org/web/20170129131616/https://coreos.com/blog/introducing-operators.html) 읽기 (이 링크는 원본 글에 대한 보관 버전임) * 오퍼레이터 구축을 위한 모범 사례에 대한 구글 클라우드(Google Cloud)의 [기사](https://cloud.google.com/blog/products/containers-kubernetes/best-practices-for-building-kubernetes-operators-and-stateful-apps) 읽기 diff --git a/content/ko/docs/concepts/scheduling-eviction/assign-pod-node.md b/content/ko/docs/concepts/scheduling-eviction/assign-pod-node.md index f9e739d7a1..dba31a6c7f 100644 --- a/content/ko/docs/concepts/scheduling-eviction/assign-pod-node.md +++ b/content/ko/docs/concepts/scheduling-eviction/assign-pod-node.md @@ -5,7 +5,7 @@ title: 노드에 파드 할당하기 content_type: concept -weight: 50 +weight: 20 --- diff --git a/content/ko/docs/concepts/scheduling-eviction/resource-bin-packing.md b/content/ko/docs/concepts/scheduling-eviction/resource-bin-packing.md index f23396d936..d11b7fe2ae 100644 --- a/content/ko/docs/concepts/scheduling-eviction/resource-bin-packing.md +++ b/content/ko/docs/concepts/scheduling-eviction/resource-bin-packing.md @@ -5,7 +5,7 @@ title: 확장된 리소스를 위한 리소스 빈 패킹(bin packing) content_type: concept -weight: 50 +weight: 30 --- diff --git a/content/ko/docs/concepts/storage/dynamic-provisioning.md b/content/ko/docs/concepts/storage/dynamic-provisioning.md index 412645e734..d39289106e 100644 --- a/content/ko/docs/concepts/storage/dynamic-provisioning.md +++ b/content/ko/docs/concepts/storage/dynamic-provisioning.md @@ -75,8 +75,8 @@ parameters: 사용자는 `PersistentVolumeClaim` 에 스토리지 클래스를 포함시켜 동적으로 프로비전된 스토리지를 요청한다. 쿠버네티스 v1.6 이전에는 `volume.beta.kubernetes.io/storage-class` 어노테이션을 통해 수행되었다. 그러나 이 어노테이션은 -v1.6부터 더 이상 사용하지 않는다. 사용자는 이제 `PersistentVolumeClaim` 오브젝트의 -`storageClassName` 필드를 사용할 수 있기에 대신하여 사용해야 한다. 이 필드의 값은 +v1.9부터는 더 이상 사용하지 않는다. 사용자는 이제 `PersistentVolumeClaim` 오브젝트의 +`storageClassName` 필드를 사용해야 한다. 이 필드의 값은 관리자가 구성한 `StorageClass` 의 이름과 일치해야 한다. ([아래](#동적-프로비저닝-활성화하기)를 참고) diff --git a/content/ko/docs/concepts/storage/volumes.md b/content/ko/docs/concepts/storage/volumes.md index c9b3ac80d9..5323182966 100644 --- a/content/ko/docs/concepts/storage/volumes.md +++ b/content/ko/docs/concepts/storage/volumes.md @@ -31,7 +31,8 @@ weight: 10 임시 볼륨 유형은 파드의 수명을 갖지만, 퍼시스턴트 볼륨은 파드의 수명을 넘어 존재한다. 결과적으로, 볼륨은 파드 내에서 실행되는 모든 컨테이너보다 오래 지속되며, 컨테이너를 다시 시작해도 데이터가 보존된다. 파드가 -더 이상 존재하지 않으면, 볼륨은 삭제된다. +더 이상 존재하지 않으면, 쿠버네티스는 임시(ephemeral) 볼륨을 삭제하지만, +퍼시스턴트(persistent) 볼륨은 삭제하지 않는다. 기본적으로 볼륨은 디렉터리일 뿐이며, 일부 데이터가 있을 수 있으며, 파드 내 컨테이너에서 접근할 수 있다. 디렉터리의 생성 방식, 이를 지원하는 diff --git a/content/ko/docs/concepts/workloads/controllers/deployment.md b/content/ko/docs/concepts/workloads/controllers/deployment.md index f6b9979d47..fede8a46c8 100644 --- a/content/ko/docs/concepts/workloads/controllers/deployment.md +++ b/content/ko/docs/concepts/workloads/controllers/deployment.md @@ -51,8 +51,8 @@ _디플로이먼트(Deployment)_ 는 {{< glossary_tooltip text="파드" term_id= {{< note >}} `.spec.selector.matchLabels` 필드는 {key,value}의 쌍으로 매핑되어있다. `matchLabels` 에 매핑된 - 단일 {key,value}은 `matchExpressions` 의 요소에 해당하며, 키 필드는 "key"에 그리고 연산자는 "In"에 대응되며 - 값 배열은 "value"만 포함한다. + 단일 {key,value}은 `matchExpressions` 의 요소에 해당하며, `key` 필드는 "key"에 그리고 `operator`는 "In"에 대응되며 + `value` 배열은 "value"만 포함한다. 매칭을 위해서는 `matchLabels` 와 `matchExpressions` 의 모든 요건이 충족되어야 한다. {{< /note >}} diff --git a/content/ko/docs/reference/_index.md b/content/ko/docs/reference/_index.md index c294f2efb5..ff1727ffee 100644 --- a/content/ko/docs/reference/_index.md +++ b/content/ko/docs/reference/_index.md @@ -6,6 +6,7 @@ linkTitle: "레퍼런스" main_menu: true weight: 70 content_type: concept +no_list: true --- @@ -18,11 +19,17 @@ content_type: concept ## API 레퍼런스 +* [표준 용어집](/ko/docs/reference/glossary/) - 포괄적이고, 표준화 된 쿠버네티스 용어 목록 + + + * [쿠버네티스 API 레퍼런스](/docs/reference/kubernetes-api/) * [쿠버네티스 {{< param "version" >}}용 원페이지(One-page) API 레퍼런스](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/) * [쿠버네티스 API 사용](/ko/docs/reference/using-api/) - 쿠버네티스 API에 대한 개요 +* [API 접근 제어](/ko/docs/reference/access-authn-authz/) - 쿠버네티스가 API 접근을 제어하는 방법에 대한 세부사항 +* [잘 알려진 레이블, 어노테이션과 테인트](/docs/reference/kubernetes-api/labels-annotations-taints/) -## API 클라이언트 라이브러리 +## 공식적으로 지원되는 클라이언트 라이브러리 프로그래밍 언어에서 쿠버네티스 API를 호출하기 위해서, [클라이언트 라이브러리](/ko/docs/reference/using-api/client-libraries/)를 사용할 수 있다. @@ -32,22 +39,27 @@ content_type: concept - [쿠버네티스 Python 클라이언트 라이브러리](https://github.com/kubernetes-client/python) - [쿠버네티스 Java 클라이언트 라이브러리](https://github.com/kubernetes-client/java) - [쿠버네티스 JavaScript 클라이언트 라이브러리](https://github.com/kubernetes-client/javascript) +- [쿠버네티스 Dotnet 클라이언트 라이브러리](https://github.com/kubernetes-client/csharp) +- [쿠버네티스 Haskell 클라이언트 라이브러리](https://github.com/kubernetes-client/haskell) -## CLI 레퍼런스 +## CLI * [kubectl](/ko/docs/reference/kubectl/overview/) - 명령어를 실행하거나 쿠버네티스 클러스터를 관리하기 위해 사용하는 주된 CLI 도구. * [JSONPath](/ko/docs/reference/kubectl/jsonpath/) - kubectl에서 [JSONPath 표현](https://goessner.net/articles/JsonPath/)을 사용하기 위한 문법 가이드. * [kubeadm](/ko/docs/reference/setup-tools/kubeadm/) - 안정적인 쿠버네티스 클러스터를 쉽게 프로비전하기 위한 CLI 도구. -## 컴포넌트 레퍼런스 +## 컴포넌트 * [kubelet](/docs/reference/command-line-tools-reference/kubelet/) - 각 노드에서 구동되는 주요한 *노드 에이전트*. kubelet은 PodSpecs 집합을 가지며 기술된 컨테이너가 구동되고 있는지, 정상 작동하는지를 보장한다. * [kube-apiserver](/docs/reference/command-line-tools-reference/kube-apiserver/) - 파드, 서비스, 레플리케이션 컨트롤러와 같은 API 오브젝트에 대한 검증과 구성을 수행하는 REST API. * [kube-controller-manager](/docs/reference/command-line-tools-reference/kube-controller-manager/) - 쿠버네티스에 탑재된 핵심 제어 루프를 포함하는 데몬. * [kube-proxy](/docs/reference/command-line-tools-reference/kube-proxy/) - 간단한 TCP/UDP 스트림 포워딩이나 백-엔드 집합에 걸쳐서 라운드-로빈 TCP/UDP 포워딩을 할 수 있다. * [kube-scheduler](/docs/reference/command-line-tools-reference/kube-scheduler/) - 가용성, 성능 및 용량을 관리하는 스케줄러. - * [kube-scheduler 정책](/ko/docs/reference/scheduling/policies) - * [kube-scheduler 프로파일](/docs/reference/scheduling/config#profiles) + +## 스케줄링 + +* [kube-scheduler 정책](/ko/docs/reference/scheduling/policies) +* [kube-scheduler 프로파일](/docs/reference/scheduling/config#profiles) ## 설계 문서 diff --git a/content/ko/docs/reference/access-authn-authz/_index.md b/content/ko/docs/reference/access-authn-authz/_index.md index 9e23c5d767..0c910199b7 100644 --- a/content/ko/docs/reference/access-authn-authz/_index.md +++ b/content/ko/docs/reference/access-authn-authz/_index.md @@ -1,6 +1,6 @@ --- title: API 접근 제어 -weight: 20 +weight: 15 no_list: true --- diff --git a/content/ko/docs/reference/command-line-tools-reference/_index.md b/content/ko/docs/reference/command-line-tools-reference/_index.md index 14025d0f71..d975db37b1 100644 --- a/content/ko/docs/reference/command-line-tools-reference/_index.md +++ b/content/ko/docs/reference/command-line-tools-reference/_index.md @@ -1,4 +1,4 @@ --- -title: 커맨드 라인 도구 레퍼런스 +title: 컴포넌트 도구 weight: 60 --- diff --git a/content/ko/docs/reference/command-line-tools-reference/feature-gates.md b/content/ko/docs/reference/command-line-tools-reference/feature-gates.md index 93683ae9b1..62fb53396c 100644 --- a/content/ko/docs/reference/command-line-tools-reference/feature-gates.md +++ b/content/ko/docs/reference/command-line-tools-reference/feature-gates.md @@ -242,6 +242,7 @@ kubelet과 같은 컴포넌트의 기능 게이트를 설정하려면, 기능 | `DynamicProvisioningScheduling` | - | 사용중단| 1.12 | - | | `DynamicVolumeProvisioning` | `true` | 알파 | 1.3 | 1.7 | | `DynamicVolumeProvisioning` | `true` | GA | 1.8 | - | +| `EnableAggregatedDiscoveryTimeout` | `true` | 사용중단 | 1.16 | - | | `EnableEquivalenceClassCache` | `false` | 알파 | 1.8 | 1.14 | | `EnableEquivalenceClassCache` | - | 사용중단 | 1.15 | - | | `ExperimentalCriticalPodAnnotation` | `false` | 알파 | 1.5 | 1.12 | diff --git a/content/ko/docs/reference/command-line-tools-reference/kube-proxy.md b/content/ko/docs/reference/command-line-tools-reference/kube-proxy.md index 565c3b4faf..e4c790c491 100644 --- a/content/ko/docs/reference/command-line-tools-reference/kube-proxy.md +++ b/content/ko/docs/reference/command-line-tools-reference/kube-proxy.md @@ -2,8 +2,21 @@ title: kube-proxy content_type: tool-reference weight: 30 +auto_generated: true --- + + + ## {{% heading "synopsis" %}} @@ -32,308 +45,308 @@ kube-proxy [flags] --azure-container-registry-config string -Azure 컨테이너 레지스트리 구성 정보가 들어 있는 파일의 경로. +

    Azure 컨테이너 레지스트리 구성 정보가 들어 있는 파일의 경로.

    ---bind-address ip     기본값: 0.0.0.0 +--bind-address string     기본값: 0.0.0.0 -프록시 서버가 서비스할 IP 주소(모든 IPv4 인터페이스의 경우 '0.0.0.0'으로 설정, 모든 IPv6 인터페이스의 경우 '::'로 설정) +

    프록시 서버가 서비스할 IP 주소(모든 IPv4 인터페이스의 경우 '0.0.0.0'으로 설정, 모든 IPv6 인터페이스의 경우 '::'로 설정)

    --bind-address-hard-fail -true인 경우 kube-proxy는 포트 바인딩 실패를 치명적인 것으로 간주하고 종료한다. +

    true인 경우 kube-proxy는 포트 바인딩 실패를 치명적인 것으로 간주하고 종료한다.

    --cleanup -true인 경우 iptables 및 ipvs 규칙을 제거하고 종료한다. +

    true인 경우 iptables 및 ipvs 규칙을 제거하고 종료한다.

    --cluster-cidr string -클러스터에 있는 파드의 CIDR 범위. 구성 후에는 이 범위 밖에서 서비스 클러스터 IP로 전송되는 트래픽은 마스커레이드되고 파드에서 외부 LoadBalancer IP로 전송된 트래픽은 대신 해당 클러스터 IP로 전송된다 +

    클러스터에 있는 파드의 CIDR 범위. 구성 후에는 이 범위 밖에서 서비스 클러스터 IP로 전송되는 트래픽은 마스커레이드되고 파드에서 외부 LoadBalancer IP로 전송된 트래픽은 대신 해당 클러스터 IP로 전송된다

    --config string -설정 파일의 경로. +

    설정 파일의 경로.

    --config-sync-period duration     기본값: 15m0s -apiserver의 설정이 갱신되는 빈도. 0보다 커야 한다. +

    apiserver의 설정이 갱신되는 빈도. 0보다 커야 한다.

    --conntrack-max-per-core int32     기본값: 32768 -CPU 코어당 추적할 최대 NAT 연결 수(한도(limit)를 그대로 두고 contrack-min을 무시하려면 0으로 설정한다)( +

    CPU 코어당 추적할 최대 NAT 연결 수(한도(limit)를 그대로 두고 contrack-min을 무시하려면 0으로 설정한다)(

    --conntrack-min int32     기본값: 131072 -conntrack-max-per-core와 관계없이 할당할 최소 conntrack 항목 수(한도를 그대로 두려면 conntrack-max-per-core값을 0으로 설정). +

    conntrack-max-per-core와 관계없이 할당할 최소 conntrack 항목 수(한도를 그대로 두려면 conntrack-max-per-core값을 0으로 설정).

    --conntrack-tcp-timeout-close-wait duration     기본값: 1h0m0s -CLOSE_WAIT 상태의 TCP 연결에 대한 NAT 시간 초과 +

    CLOSE_WAIT 상태의 TCP 연결에 대한 NAT 시간 초과

    --conntrack-tcp-timeout-established duration     기본값: 24h0m0s -설정된 TCP 연결에 대한 유휴시간 초과(값이 0이면 그대로 유지) +

    설정된 TCP 연결에 대한 유휴시간 초과(값이 0이면 그대로 유지)

    --detect-local-mode LocalMode -로컬 트래픽을 탐지하는 데 사용할 모드 +

    로컬 트래픽을 탐지하는 데 사용할 모드

    --feature-gates mapStringBool -알파/실험 기능에 대한 기능 게이트를 설명하는 키=값 쌍 집합. 옵션은 다음과 같다.
    APIListChunking=true|false (BETA - 기본값=true)
    APIPriorityAndFairness=true|false (ALPHA - 기본값=false)
    APIResponseCompression=true|false (BETA - 기본값=true)
    AllAlpha=true|false (ALPHA - 기본값=false)
    AllBeta=true|false (BETA - 기본값=false)
    AllowInsecureBackendProxy=true|false (BETA - 기본값=true)
    AnyVolumeDataSource=true|false (ALPHA - 기본값=false)
    AppArmor=true|false (BETA - 기본값=true)
    BalanceAttachedNodeVolumes=true|false (ALPHA - 기본값=false)
    BoundServiceAccountTokenVolume=true|false (ALPHA - 기본값=false)
    CPUManager=true|false (BETA - 기본값=true)
    CRIContainerLogRotation=true|false (BETA - 기본값=true)
    CSIInlineVolume=true|false (BETA - 기본값=true)
    CSIMigration=true|false (BETA - 기본값=true)
    CSIMigrationAWS=true|false (BETA - 기본값=false)
    CSIMigrationAWSComplete=true|false (ALPHA - 기본값=false)
    CSIMigrationAzureDisk=true|false (BETA - 기본값=false)
    CSIMigrationAzureDiskComplete=true|false (ALPHA - 기본값=false)
    CSIMigrationAzureFile=true|false (ALPHA - 기본값=false)
    CSIMigrationAzureFileComplete=true|false (ALPHA - 기본값=false)
    CSIMigrationGCE=true|false (BETA - 기본값=false)
    CSIMigrationGCEComplete=true|false (ALPHA - 기본값=false)
    CSIMigrationOpenStack=true|false (BETA - 기본값=false)
    CSIMigrationOpenStackComplete=true|false (ALPHA - 기본값=false)
    CSIMigrationvSphere=true|false (BETA - 기본값=false)
    CSIMigrationvSphereComplete=true|false (BETA - 기본값=false)
    CSIStorageCapacity=true|false (ALPHA - 기본값=false)
    CSIVolumeFSGroupPolicy=true|false (ALPHA - 기본값=false)
    ConfigurableFSGroupPolicy=true|false (ALPHA - 기본값=false)
    CustomCPUCFSQuotaPeriod=true|false (ALPHA - 기본값=false)
    DefaultPodTopologySpread=true|false (ALPHA - 기본값=false)
    DevicePlugins=true|false (BETA - 기본값=true)
    DisableAcceleratorUsageMetrics=true|false (ALPHA - 기본값=false)
    DynamicKubeletConfig=true|false (BETA - 기본값=true)
    EndpointSlice=true|false (BETA - 기본값=true)
    EndpointSliceProxying=true|false (BETA - 기본값=true)
    EphemeralContainers=true|false (ALPHA - 기본값=false)
    ExpandCSIVolumes=true|false (BETA - 기본값=true)
    ExpandInUsePersistentVolumes=true|false (BETA - 기본값=true)
    ExpandPersistentVolumes=true|false (BETA - 기본값=true)
    ExperimentalHostUserNamespaceDefaulting=true|false (BETA - 기본값=false)
    GenericEphemeralVolume=true|false (ALPHA - 기본값=false)
    HPAScaleToZero=true|false (ALPHA - 기본값=false)
    HugePageStorageMediumSize=true|false (BETA - 기본값=true)
    HyperVContainer=true|false (ALPHA - 기본값=false)
    IPv6DualStack=true|false (ALPHA - 기본값=false)
    ImmutableEphemeralVolumes=true|false (BETA - 기본값=true)
    KubeletPodResources=true|false (BETA - 기본값=true)
    LegacyNodeRoleBehavior=true|false (BETA - 기본값=true)
    LocalStorageCapacityIsolation=true|false (BETA - 기본값=true)
    LocalStorageCapacityIsolationFSQuotaMonitoring=true|false (ALPHA - 기본값=false)
    NodeDisruptionExclusion=true|false (BETA - 기본값=true)
    NonPreemptingPriority=true|false (BETA - 기본값=true)
    PodDisruptionBudget=true|false (BETA - 기본값=true)
    PodOverhead=true|false (BETA - 기본값=true)
    ProcMountType=true|false (ALPHA - 기본값=false)
    QOSReserved=true|false (ALPHA - 기본값=false)
    RemainingItemCount=true|false (BETA - 기본값=true)
    RemoveSelfLink=true|false (ALPHA - 기본값=false)
    RotateKubeletServerCertificate=true|false (BETA - 기본값=true)
    RunAsGroup=true|false (BETA - 기본값=true)
    RuntimeClass=true|false (BETA - 기본값=true)
    SCTPSupport=true|false (BETA - 기본값=true)
    SelectorIndex=true|false (BETA - 기본값=true)
    ServerSideApply=true|false (BETA - 기본값=true)
    ServiceAccountIssuerDiscovery=true|false (ALPHA - 기본값=false)
    ServiceAppProtocol=true|false (BETA - 기본값=true)
    ServiceNodeExclusion=true|false (BETA - 기본값=true)
    ServiceTopology=true|false (ALPHA - 기본값=false)
    SetHostnameAsFQDN=true|false (ALPHA - 기본값=false)
    StartupProbe=true|false (BETA - 기본값=true)
    StorageVersionHash=true|false (BETA - 기본값=true)
    SupportNodePidsLimit=true|false (BETA - 기본값=true)
    SupportPodPidsLimit=true|false (BETA - 기본값=true)
    Sysctls=true|false (BETA - 기본값=true)
    TTLAfterFinished=true|false (ALPHA - 기본값=false)
    TokenRequest=true|false (BETA - 기본값=true)
    TokenRequestProjection=true|false (BETA - 기본값=true)
    TopologyManager=true|false (BETA - 기본값=true)
    ValidateProxyRedirects=true|false (BETA - 기본값=true)
    VolumeSnapshotDataSource=true|false (BETA - 기본값=true)
    WarningHeaders=true|false (BETA - 기본값=true)
    WinDSR=true|false (ALPHA - 기본값=false)
    WinOverlay=true|false (ALPHA - 기본값=false)
    WindowsEndpointSliceProxying=true|false (ALPHA - 기본값=false) +

    알파/실험 기능에 대한 기능 게이트를 설명하는 키=값 쌍 집합. 옵션은 다음과 같다.
    APIListChunking=true|false (BETA - 기본값=true)
    APIPriorityAndFairness=true|false (ALPHA - 기본값=false)
    APIResponseCompression=true|false (BETA - 기본값=true)
    AllAlpha=true|false (ALPHA - 기본값=false)
    AllBeta=true|false (BETA - 기본값=false)
    AllowInsecureBackendProxy=true|false (BETA - 기본값=true)
    AnyVolumeDataSource=true|false (ALPHA - 기본값=false)
    AppArmor=true|false (BETA - 기본값=true)
    BalanceAttachedNodeVolumes=true|false (ALPHA - 기본값=false)
    BoundServiceAccountTokenVolume=true|false (ALPHA - 기본값=false)
    CPUManager=true|false (BETA - 기본값=true)
    CRIContainerLogRotation=true|false (BETA - 기본값=true)
    CSIInlineVolume=true|false (BETA - 기본값=true)
    CSIMigration=true|false (BETA - 기본값=true)
    CSIMigrationAWS=true|false (BETA - 기본값=false)
    CSIMigrationAWSComplete=true|false (ALPHA - 기본값=false)
    CSIMigrationAzureDisk=true|false (BETA - 기본값=false)
    CSIMigrationAzureDiskComplete=true|false (ALPHA - 기본값=false)
    CSIMigrationAzureFile=true|false (ALPHA - 기본값=false)
    CSIMigrationAzureFileComplete=true|false (ALPHA - 기본값=false)
    CSIMigrationGCE=true|false (BETA - 기본값=false)
    CSIMigrationGCEComplete=true|false (ALPHA - 기본값=false)
    CSIMigrationOpenStack=true|false (BETA - 기본값=false)
    CSIMigrationOpenStackComplete=true|false (ALPHA - 기본값=false)
    CSIMigrationvSphere=true|false (BETA - 기본값=false)
    CSIMigrationvSphereComplete=true|false (BETA - 기본값=false)
    CSIStorageCapacity=true|false (ALPHA - 기본값=false)
    CSIVolumeFSGroupPolicy=true|false (ALPHA - 기본값=false)
    ConfigurableFSGroupPolicy=true|false (ALPHA - 기본값=false)
    CustomCPUCFSQuotaPeriod=true|false (ALPHA - 기본값=false)
    DefaultPodTopologySpread=true|false (ALPHA - 기본값=false)
    DevicePlugins=true|false (BETA - 기본값=true)
    DisableAcceleratorUsageMetrics=true|false (ALPHA - 기본값=false)
    DynamicKubeletConfig=true|false (BETA - 기본값=true)
    EndpointSlice=true|false (BETA - 기본값=true)
    EndpointSliceProxying=true|false (BETA - 기본값=true)
    EphemeralContainers=true|false (ALPHA - 기본값=false)
    ExpandCSIVolumes=true|false (BETA - 기본값=true)
    ExpandInUsePersistentVolumes=true|false (BETA - 기본값=true)
    ExpandPersistentVolumes=true|false (BETA - 기본값=true)
    ExperimentalHostUserNamespaceDefaulting=true|false (BETA - 기본값=false)
    GenericEphemeralVolume=true|false (ALPHA - 기본값=false)
    HPAScaleToZero=true|false (ALPHA - 기본값=false)
    HugePageStorageMediumSize=true|false (BETA - 기본값=true)
    HyperVContainer=true|false (ALPHA - 기본값=false)
    IPv6DualStack=true|false (ALPHA - 기본값=false)
    ImmutableEphemeralVolumes=true|false (BETA - 기본값=true)
    KubeletPodResources=true|false (BETA - 기본값=true)
    LegacyNodeRoleBehavior=true|false (BETA - 기본값=true)
    LocalStorageCapacityIsolation=true|false (BETA - 기본값=true)
    LocalStorageCapacityIsolationFSQuotaMonitoring=true|false (ALPHA - 기본값=false)
    NodeDisruptionExclusion=true|false (BETA - 기본값=true)
    NonPreemptingPriority=true|false (BETA - 기본값=true)
    PodDisruptionBudget=true|false (BETA - 기본값=true)
    PodOverhead=true|false (BETA - 기본값=true)
    ProcMountType=true|false (ALPHA - 기본값=false)
    QOSReserved=true|false (ALPHA - 기본값=false)
    RemainingItemCount=true|false (BETA - 기본값=true)
    RemoveSelfLink=true|false (ALPHA - 기본값=false)
    RotateKubeletServerCertificate=true|false (BETA - 기본값=true)
    RunAsGroup=true|false (BETA - 기본값=true)
    RuntimeClass=true|false (BETA - 기본값=true)
    SCTPSupport=true|false (BETA - 기본값=true)
    SelectorIndex=true|false (BETA - 기본값=true)
    ServerSideApply=true|false (BETA - 기본값=true)
    ServiceAccountIssuerDiscovery=true|false (ALPHA - 기본값=false)
    ServiceAppProtocol=true|false (BETA - 기본값=true)
    ServiceNodeExclusion=true|false (BETA - 기본값=true)
    ServiceTopology=true|false (ALPHA - 기본값=false)
    SetHostnameAsFQDN=true|false (ALPHA - 기본값=false)
    StartupProbe=true|false (BETA - 기본값=true)
    StorageVersionHash=true|false (BETA - 기본값=true)
    SupportNodePidsLimit=true|false (BETA - 기본값=true)
    SupportPodPidsLimit=true|false (BETA - 기본값=true)
    Sysctls=true|false (BETA - 기본값=true)
    TTLAfterFinished=true|false (ALPHA - 기본값=false)
    TokenRequest=true|false (BETA - 기본값=true)
    TokenRequestProjection=true|false (BETA - 기본값=true)
    TopologyManager=true|false (BETA - 기본값=true)
    ValidateProxyRedirects=true|false (BETA - 기본값=true)
    VolumeSnapshotDataSource=true|false (BETA - 기본값=true)
    WarningHeaders=true|false (BETA - 기본값=true)
    WinDSR=true|false (ALPHA - 기본값=false)
    WinOverlay=true|false (ALPHA - 기본값=false)
    WindowsEndpointSliceProxying=true|false (ALPHA - 기본값=false)

    --healthz-bind-address ipport     기본값: 0.0.0.0:10256 -헬스 체크 서버가 서비스할 포트가 있는 IP 주소(모든 IPv4의 인터페이스의 경우 '0.0.0.0:10256', 모든 IPv6의 인터페이스인 경우 '[::]:10256'로 설정). 사용 안 할 경우 빈칸으로 둠. +

    헬스 체크 서버가 서비스할 포트가 있는 IP 주소(모든 IPv4의 인터페이스의 경우 '0.0.0.0:10256', 모든 IPv6의 인터페이스인 경우 '[::]:10256'로 설정). 사용 안 할 경우 빈칸으로 둠.

    -h, --help -kube-proxy에 대한 도움말. +

    kube-proxy에 대한 도움말.

    --hostname-override string -문자열 값이 있으면, 이 값을 실제 호스트네임 대신에 ID로 사용한다. +

    문자열 값이 있으면, 이 값을 실제 호스트네임 대신에 ID로 사용한다.

    --iptables-masquerade-bit int32     기본값: 14 -순수 iptable 프록시를 사용하는 경우 SNAT가 필요한 패킷을 표시하는 fwmark 스페이스 비트. [0, 31] 범위 안에 있어야 한다. +

    순수 iptable 프록시를 사용하는 경우 SNAT가 필요한 패킷을 표시하는 fwmark 스페이스 비트. [0, 31] 범위 안에 있어야 한다.

    --iptables-min-sync-period duration     기본값: 1s -엔드포인트 및 서비스가 변경될 때 iptable 규칙을 새로 고칠 수 있는 빈도의 최소 간격(예: '5s', '1m', '2h22m'). +

    엔드포인트 및 서비스가 변경될 때 iptable 규칙을 새로 고칠 수 있는 빈도의 최소 간격(예: '5s', '1m', '2h22m').

    --iptables-sync-period duration     기본값: 30s -iptable 규칙을 새로 고치는 빈도의 최대 간격(예: '5s', '1m', '2h22m'). 0 보다 커야 한다. +

    iptable 규칙을 새로 고치는 빈도의 최대 간격(예: '5s', '1m', '2h22m'). 0 보다 커야 한다.

    --ipvs-exclude-cidrs stringSlice -IPVS 규칙을 정리할 때 ipvs 프록시가 건드리지 않아야 하는 쉼표로 구분된 CIDR 목록. +

    IPVS 규칙을 정리할 때 ipvs 프록시가 건드리지 않아야 하는 쉼표로 구분된 CIDR 목록.

    --ipvs-min-sync-period duration -엔드포인트 및 서비스가 변경될 때 ipvs 규칙을 새로 고칠 수 있는 빈도의 최소 간격(예: '5s', '1m', '2h22m'). +

    엔드포인트 및 서비스가 변경될 때 ipvs 규칙을 새로 고칠 수 있는 빈도의 최소 간격(예: '5s', '1m', '2h22m').

    --ipvs-scheduler string -프록시 모드가 ipvs인 경우 ipvs 스케줄러 유형. +

    프록시 모드가 ipvs인 경우 ipvs 스케줄러 유형.

    --ipvs-strict-arp -arp_ignore를 1로 설정하고 arp_annotes를 2로 설정하여 엄격한 ARP를 사용. +

    arp_ignore를 1로 설정하고 arp_annotes를 2로 설정하여 엄격한 ARP를 사용.

    --ipvs-sync-period duration     기본값: 30s -ipvs 규칙이 새로 갱신되는 빈도의 최대 간격(예: '5s', '1m', '2h22m'). 0 보다 커야 한다. +

    ipvs 규칙이 새로 갱신되는 빈도의 최대 간격(예: '5s', '1m', '2h22m'). 0 보다 커야 한다.

    --ipvs-tcp-timeout duration -유휴 IPVS TCP 연결에 대한 시간 초과. 0이면 그대로 유지(예: '5s', '1m', '2h22m'). +

    유휴 IPVS TCP 연결에 대한 시간 초과. 0이면 그대로 유지(예: '5s', '1m', '2h22m').

    --ipvs-tcpfin-timeout duration -FIN 패킷을 수신한 후 IPVS TCP 연결에 대한 시간 초과. 0이면 그대로 유지(예: '5s', '1m', '2h22m'). +

    FIN 패킷을 수신한 후 IPVS TCP 연결에 대한 시간 초과. 0이면 그대로 유지(예: '5s', '1m', '2h22m').

    --ipvs-udp-timeout duration -IPVS UDP 패킷에 대한 시간 초과. 0이면 그대로 유지(예: '5s', '1m', '2h22m'). +

    IPVS UDP 패킷에 대한 시간 초과. 0이면 그대로 유지(예: '5s', '1m', '2h22m').

    --kube-api-burst int32     기본값: 10 -쿠버네티스 api 서버와 통신하는 동안 사용할 burst. +

    쿠버네티스 api 서버와 통신하는 동안 사용할 burst.

    --kube-api-content-type string     기본값: "application/vnd.kubernetes.protobuf" -api 서버에 보낸 요청의 내용 유형. +

    api 서버에 보낸 요청의 내용 유형.

    --kube-api-qps float32     기본값: 5 -쿠버네티스 api 서버와 통신할 때 사용할 QPS. +

    쿠버네티스 api 서버와 통신할 때 사용할 QPS.

    --kubeconfig string -인증 정보가 있는 kubeconfig 파일의 경로(마스터 위치는 마스터 플래그로 설정됨). +

    인증 정보가 있는 kubeconfig 파일의 경로(마스터 위치는 마스터 플래그로 설정됨).

    --log-flush-frequency duration     기본값: 5s -로그 플러시 사이의 최대 시간 +

    로그 플러시 사이의 최대 시간

    --masquerade-all -순수 iptables 프록시를 사용하는 경우 서비스 클러스터 IP를 통해 전송된 모든 트래픽을 SNAT함(일반적으로 필요하지 않음). +

    순수 iptables 프록시를 사용하는 경우 서비스 클러스터 IP를 통해 전송된 모든 트래픽을 SNAT함(일반적으로 필요하지 않음).

    --master string -쿠버네티스 API 서버의 주소(kubeconfig의 모든 값 덮어쓰기). +

    쿠버네티스 API 서버의 주소(kubeconfig의 모든 값 덮어쓰기).

    --metrics-bind-address ipport     기본값: 127.0.0.1:10249 -메트릭 서버가 서비스할 포트가 있는 IP 주소(모든 IPv4 인터페이스의 경우 '0.0.0.0:10249', 모든 IPv6 인터페이스의 경우 '[::]:10249'로 설정됨). 사용하지 않으려면 비워둘 것. +

    메트릭 서버가 서비스할 포트가 있는 IP 주소(모든 IPv4 인터페이스의 경우 '0.0.0.0:10249', 모든 IPv6 인터페이스의 경우 '[::]:10249'로 설정됨). 사용하지 않으려면 비워둘 것.

    --nodeport-addresses stringSlice -NodePort에 사용할 주소를 지정하는 값의 문자열 조각. 값은 유효한 IP 블록(예: 1.2.3.0/24, 1.2.3.4/32). 기본값인 빈 문자열 조각값은([]) 모든 로컬 주소를 사용하는 것을 의미한다. +

    NodePort에 사용할 주소를 지정하는 값의 문자열 조각. 값은 유효한 IP 블록(예: 1.2.3.0/24, 1.2.3.4/32). 기본값인 빈 문자열 조각값은([]) 모든 로컬 주소를 사용하는 것을 의미한다.

    --oom-score-adj int32     기본값: -999 -kube-proxy 프로세스에 대한 oom-score-adj 값. 값은 [-1000, 1000] 범위 내에 있어야 한다. +

    kube-proxy 프로세스에 대한 oom-score-adj 값. 값은 [-1000, 1000] 범위 내에 있어야 한다.

    --profiling -값이 true이면 /debug/pprof 핸들러에서 웹 인터페이스를 통한 프로파일링을 활성화한다. +

    값이 true이면 /debug/pprof 핸들러에서 웹 인터페이스를 통한 프로파일링을 활성화한다.

    --proxy-mode ProxyMode -사용할 프록시 모드: 'userspace' (이전) or 'iptables' (빠름) or 'ipvs' or 'kernelspace' (윈도우). 공백인 경우 가장 잘 사용할 수 있는 프록시(현재는 iptables)를 사용한다. iptables 프록시를 선택했지만, 시스템의 커널 또는 iptables 버전이 맞지 않으면, 항상 userspace 프록시로 변경된다. +

    사용할 프록시 모드: 'userspace' (이전) or 'iptables' (빠름) or 'ipvs' or 'kernelspace' (윈도우). 공백인 경우 가장 잘 사용할 수 있는 프록시(현재는 iptables)를 사용한다. iptables 프록시를 선택했지만, 시스템의 커널 또는 iptables 버전이 맞지 않으면, 항상 userspace 프록시로 변경된다.

    --proxy-port-range port-range -서비스 트래픽을 프록시하기 위해 사용할 수 있는 호스트 포트 범위(beginPort-endPort, single port 또는 beginPort+offset 포함). 만약 범위가 0, 0-0, 혹은 지정되지 않으면, 포트는 무작위로 선택된다. +

    서비스 트래픽을 프록시하기 위해 사용할 수 있는 호스트 포트 범위(beginPort-endPort, single port 또는 beginPort+offset 포함). 만약 범위가 0, 0-0, 혹은 지정되지 않으면, 포트는 무작위로 선택된다.

    --show-hidden-metrics-for-version string -숨겨진 메트릭을 표시할 이전 버전. +

    숨겨진 메트릭을 표시할 이전 버전.

    --udp-timeout duration     기본값: 250ms -유휴 UDP 연결이 열린 상태로 유지되는 시간(예: '250ms', '2s'). 값은 0보다 커야 한다. 프록시 모드 userspace에만 적용 가능함. +

    유휴 UDP 연결이 열린 상태로 유지되는 시간(예: '250ms', '2s'). 값은 0보다 커야 한다. 프록시 모드 userspace에만 적용 가능함.

    --version version[=true] -버전 정보를 인쇄하고 종료. +

    버전 정보를 인쇄하고 종료.

    --write-config-to string -기본 구성 값을 이 파일에 옮겨쓰고 종료한다. +

    기본 구성 값을 이 파일에 옮겨쓰고 종료한다.

    diff --git a/content/ko/docs/reference/glossary/index.md b/content/ko/docs/reference/glossary/index.md index 9af1b3d078..024d8414ba 100755 --- a/content/ko/docs/reference/glossary/index.md +++ b/content/ko/docs/reference/glossary/index.md @@ -1,5 +1,5 @@ --- -title: 표준 용어집 +title: 용어집 layout: glossary noedit: true default_active_tag: fundamental diff --git a/content/ko/docs/reference/issues-security/_index.md b/content/ko/docs/reference/issues-security/_index.md index 596a6e01a4..12ac2f3759 100644 --- a/content/ko/docs/reference/issues-security/_index.md +++ b/content/ko/docs/reference/issues-security/_index.md @@ -1,4 +1,4 @@ --- title: 쿠버네티스 이슈와 보안 -weight: 10 +weight: 40 --- diff --git a/content/ko/docs/reference/kubectl/_index.md b/content/ko/docs/reference/kubectl/_index.md index 7b6c2d720b..765adb6fe8 100755 --- a/content/ko/docs/reference/kubectl/_index.md +++ b/content/ko/docs/reference/kubectl/_index.md @@ -1,5 +1,5 @@ --- -title: "kubectl CLI" +title: "kubectl" weight: 60 --- diff --git a/content/ko/docs/reference/kubectl/overview.md b/content/ko/docs/reference/kubectl/overview.md index 7ddfe5b095..3d8179a08a 100644 --- a/content/ko/docs/reference/kubectl/overview.md +++ b/content/ko/docs/reference/kubectl/overview.md @@ -17,7 +17,7 @@ KUBECONFIG 환경 변수를 설정하거나 [`--kubeconfig`](/ko/docs/concepts/c 이 개요는 `kubectl` 구문을 다루고, 커맨드 동작을 설명하며, 일반적인 예제를 제공한다. 지원되는 모든 플래그 및 하위 명령을 포함한 각 명령에 대한 자세한 내용은 [kubectl](/docs/reference/generated/kubectl/kubectl-commands/) 참조 문서를 참고한다. -설치 방법에 대해서는 [kubectl 설치](/ko/docs/tasks/tools/install-kubectl/)를 참고한다. +설치 방법에 대해서는 [kubectl 설치](/ko/docs/tasks/tools/)를 참고한다. diff --git a/content/ko/docs/reference/scheduling/config.md b/content/ko/docs/reference/scheduling/config.md index 0f3f120d77..7b6942e119 100644 --- a/content/ko/docs/reference/scheduling/config.md +++ b/content/ko/docs/reference/scheduling/config.md @@ -185,8 +185,6 @@ profiles: - `RequestedToCapacityRatio`: 할당된 리소스의 구성된 기능에 따라 노드를 선호한다. 익스텐션 포인트: `Score`. -- `NodeResourceLimits`: 파드 리소스 제한을 충족하는 노드를 선호한다. - 익스텐션 포인트: `PreScore`, `Score`. - `CinderVolume`: 노드에 대해 OpenStack Cinder 볼륨 제한을 충족할 수 있는지 확인한다. 익스텐션 포인트: `Filter`. diff --git a/content/ko/docs/reference/setup-tools/_index.md b/content/ko/docs/reference/setup-tools/_index.md index 051fba4c5d..717b9cb2ac 100644 --- a/content/ko/docs/reference/setup-tools/_index.md +++ b/content/ko/docs/reference/setup-tools/_index.md @@ -1,4 +1,4 @@ --- -title: 설치 도구 레퍼런스 +title: 설치 도구 weight: 50 --- diff --git a/content/ko/docs/reference/tools.md b/content/ko/docs/reference/tools/_index.md similarity index 100% rename from content/ko/docs/reference/tools.md rename to content/ko/docs/reference/tools/_index.md diff --git a/content/ko/docs/reference/using-api/_index.md b/content/ko/docs/reference/using-api/_index.md index 427cebf529..423d82e0f2 100644 --- a/content/ko/docs/reference/using-api/_index.md +++ b/content/ko/docs/reference/using-api/_index.md @@ -1,7 +1,8 @@ --- -title: 쿠버네티스 API 개요 +title: API 개요 content_type: concept weight: 10 +no_list: true card: name: 레퍼런스 weight: 50 diff --git a/content/ko/docs/setup/best-practices/certificates.md b/content/ko/docs/setup/best-practices/certificates.md index 3ada64a469..77665edbe2 100644 --- a/content/ko/docs/setup/best-practices/certificates.md +++ b/content/ko/docs/setup/best-practices/certificates.md @@ -7,7 +7,7 @@ weight: 40 쿠버네티스는 TLS 위에 인증을 위해 PKI 인증서가 필요하다. -만약 [kubeadm](/docs/reference/setup-tools/kubeadm/kubeadm/)으로 쿠버네티스를 설치했다면, 클러스터에 필요한 인증서는 자동으로 생성된다. +만약 [kubeadm](/ko/docs/reference/setup-tools/kubeadm/)으로 쿠버네티스를 설치했다면, 클러스터에 필요한 인증서는 자동으로 생성된다. 또한 더 안전하게 자신이 소유한 인증서를 생성할 수 있다. 이를 테면, 개인키를 API 서버에 저장하지 않으므로 더 안전하게 보관할 수 있다. 이 페이지는 클러스터에 필요한 인증서를 설명한다. @@ -72,7 +72,7 @@ etcd 역시 클라이언트와 피어 간에 상호 TLS 인증을 구현한다. | kube-apiserver-kubelet-client | kubernetes-ca | system:masters | client | | | front-proxy-client | kubernetes-front-proxy-ca | | client | | -[1]: 클러스터에 접속한 다른 IP 또는 DNS 이름([kubeadm](/docs/reference/setup-tools/kubeadm/kubeadm/) 이 사용하는 로드 밸런서 안정 IP 또는 DNS 이름, `kubernetes`, `kubernetes.default`, `kubernetes.default.svc`, +[1]: 클러스터에 접속한 다른 IP 또는 DNS 이름([kubeadm](/ko/docs/reference/setup-tools/kubeadm/) 이 사용하는 로드 밸런서 안정 IP 또는 DNS 이름, `kubernetes`, `kubernetes.default`, `kubernetes.default.svc`, `kubernetes.default.svc.cluster`, `kubernetes.default.svc.cluster.local`) `kind`는 하나 이상의 [x509 키 사용](https://godoc.org/k8s.io/api/certificates/v1beta1#KeyUsage) 종류를 가진다. @@ -97,7 +97,7 @@ kubeadm 사용자만 해당: ### 인증서 파일 경로 -인증서는 권고하는 파일 경로에 존재해야 한다([kubeadm](/docs/reference/setup-tools/kubeadm/kubeadm/)에서 사용되는 것처럼). 경로는 위치에 관계없이 주어진 파라미터를 사용하여 지정되야 한다. +인증서는 권고하는 파일 경로에 존재해야 한다([kubeadm](/ko/docs/reference/setup-tools/kubeadm/)에서 사용되는 것처럼). 경로는 위치에 관계없이 주어진 파라미터를 사용하여 지정해야 한다. | 기본 CN | 권고되는 키 파일 경로 | 권고하는 인증서 파일 경로 | 명령어 | 키 파라미터 | 인증서 파라미터 | |------------------------------|------------------------------|-----------------------------|----------------|------------------------------|-------------------------------------------| diff --git a/content/ko/docs/setup/best-practices/multiple-zones.md b/content/ko/docs/setup/best-practices/multiple-zones.md index 189dbed654..3d825ebd08 100644 --- a/content/ko/docs/setup/best-practices/multiple-zones.md +++ b/content/ko/docs/setup/best-practices/multiple-zones.md @@ -55,7 +55,7 @@ content_type: concept 특정 kubelet을 나타내는 노드 오브젝트에 {{< glossary_tooltip text="레이블" term_id="label" >}}을 자동으로 추가한다. 이러한 레이블에는 -[영역 정보](/docs/reference/kubernetes-api/labels-annotations-taints/#topologykubernetesiozone)가 포함될 수 있다. +[영역 정보](/docs/reference/labels-annotations-taints/#topologykubernetesiozone)가 포함될 수 있다. 클러스터가 여러 영역 또는 지역에 걸쳐있는 경우, [파드 토폴로지 분배 제약 조건](/ko/docs/concepts/workloads/pods/pod-topology-spread-constraints/)과 diff --git a/content/ko/docs/setup/production-environment/container-runtimes.md b/content/ko/docs/setup/production-environment/container-runtimes.md index ba06b3d023..52ab0fc94b 100644 --- a/content/ko/docs/setup/production-environment/container-runtimes.md +++ b/content/ko/docs/setup/production-environment/container-runtimes.md @@ -63,7 +63,7 @@ kubelet을 재시작하는 것은 에러를 해결할 수 없을 것이다. ### containerd -이 섹션에는 `containerd` 를 CRI 런타임으로 사용하는 데 필요한 단계가 포함되어 있다. +이 섹션에는 containerd 를 CRI 런타임으로 사용하는 데 필요한 단계가 포함되어 있다. 필수 구성 요소를 설치 및 구성한다. @@ -90,170 +90,63 @@ sudo sysctl --system containerd를 설치한다. {{< tabs name="tab-cri-containerd-installation" >}} -{{% tab name="Ubuntu 16.04" %}} +{{% tab name="Linux" %}} -```shell -# 도커의 공식 GPG 키 추가 -curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add - -# (containerd 설치) -## 리포지터리 설정 -### HTTPS를 통해 리포지터리를 사용할 수 있도록 패키지 설치 -sudo apt-get update && sudo apt-get install -y apt-transport-https ca-certificates curl software-properties-common -``` +1. 공식 도커 리포지터리에서 `containerd.io` 패키지를 설치한다. 각 리눅스 배포한에 대한 도커 리포지터리를 설정하고 `containerd.io` 패키지를 설치하는 방법은 [도커 엔진 설치](https://docs.docker.com/engine/install/#server)에서 찾을 수 있다. -```shell -## 도커의 공식 GPG 키 추가 -curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key --keyring /etc/apt/trusted.gpg.d/docker.gpg add - -``` +2. containerd 설정 -```shell -## 도커 apt 리포지터리 추가 -sudo add-apt-repository \ - "deb [arch=amd64] https://download.docker.com/linux/ubuntu \ - $(lsb_release -cs) \ - stable" -``` + ```shell + sudo mkdir -p /etc/containerd + containerd config default | sudo tee /etc/containerd/config.toml + ``` -```shell -## containerd 설치 -sudo apt-get update && sudo apt-get install -y containerd.io -``` +3. containerd 재시작 -```shell -# containerd 구성 -sudo mkdir -p /etc/containerd -containerd config default | sudo tee /etc/containerd/config.toml -``` + ```shell + sudo systemctl restart containerd + ``` -```shell -# containerd 재시작 -sudo systemctl restart containerd -``` -{{% /tab %}} -{{% tab name="Ubuntu 18.04/20.04" %}} - -```shell -# (containerd 설치) -sudo apt-get update && sudo apt-get install -y containerd -``` - -```shell -# containerd 구성 -sudo mkdir -p /etc/containerd -containerd config default | sudo tee /etc/containerd/config.toml -``` - -```shell -# containerd 재시작 -sudo systemctl restart containerd -``` -{{% /tab %}} -{{% tab name="Debian 9+" %}} - -```shell -# (containerd 설치) -## 리포지터리 설정 -### HTTPS를 통해 리포지터리를 사용할 수 있도록 패키지 설치 -sudo apt-get update && sudo apt-get install -y apt-transport-https ca-certificates curl software-properties-common -``` - -```shell -## 도커의 공식 GPG 키 추가 -curl -fsSL https://download.docker.com/linux/debian/gpg | sudo apt-key --keyring /etc/apt/trusted.gpg.d/docker.gpg add - -``` - -```shell -## 도커 apt 리포지터리 추가 -sudo add-apt-repository \ - "deb [arch=amd64] https://download.docker.com/linux/debian \ - $(lsb_release -cs) \ - stable" -``` - -```shell -## containerd 설치 -sudo apt-get update && sudo apt-get install -y containerd.io -``` - -```shell -# 기본 containerd 구성 설정 -sudo mkdir -p /etc/containerd -containerd config default | sudo tee /etc/containerd/config.toml -``` - -```shell -# containerd 재시작 -sudo systemctl restart containerd -``` -{{% /tab %}} -{{% tab name="CentOS/RHEL 7.4+" %}} - -```shell -# (containerd 설치) -## 리포지터리 설정 -### 필요한 패키지 설치 -sudo yum install -y yum-utils device-mapper-persistent-data lvm2 -``` - -```shell -## 도커 리포지터리 추가 -sudo yum-config-manager \ - --add-repo \ - https://download.docker.com/linux/centos/docker-ce.repo -``` - -```shell -# containerd 설치 -sudo yum update -y && sudo yum install -y containerd.io -``` - -```shell -## containerd 구성 -sudo mkdir -p /etc/containerd -containerd config default | sudo tee /etc/containerd/config.toml -``` - -```shell -# containerd 재시작 -sudo systemctl restart containerd -``` {{% /tab %}} {{% tab name="Windows (PowerShell)" %}} -
    -Powershell 세션을 띄우고, `$Version` 환경 변수를 원하는 버전으로 설정(예: `$Version=1.4.3`)한 뒤, 다음 명령어를 실행한다. -
    +PowerShell 세션을 시작하고 `$Version`을 원하는 버전(예: `$Version:1.4.3`)으로 설정한 후 다음 명령을 실행한다. -```powershell -# (containerd 설치) -# containerd 다운로드 -curl.exe -L https://github.com/containerd/containerd/releases/download/v$Version/containerd-$Version-windows-amd64.tar.gz -o containerd-windows-amd64.tar.gz -tar.exe xvf .\containerd-windows-amd64.tar.gz -``` +1. containerd 다운로드 -```powershell -# 추출 및 구성 -Copy-Item -Path ".\bin\" -Destination "$Env:ProgramFiles\containerd" -Recurse -Force -cd $Env:ProgramFiles\containerd\ -.\containerd.exe config default | Out-File config.toml -Encoding ascii + ```powershell + curl.exe -L https://github.com/containerd/containerd/releases/download/v$Version/containerd-$Version-windows-amd64.tar.gz -o containerd-windows-amd64.tar. +gz + tar.exe xvf .\containerd-windows-amd64.tar.gz + ``` -# 구성을 검토한다. 설정에 따라 조정할 수 있다. -# - sandbox_image (쿠버네티스 pause 이미지) -# - cni bin_dir 및 conf_dir locations -Get-Content config.toml +2. 추출과 설정 -# (선택 사항이지만, 강력히 권장됨) containerd를 Windows Defender 검사 예외에 추가 -Add-MpPreference -ExclusionProcess "$Env:ProgramFiles\containerd\containerd.exe" ``` + ```powershell + Copy-Item -Path ".\bin\" -Destination "$Env:ProgramFiles\containerd" -Recurse -Force + cd $Env:ProgramFiles\containerd\ + .\containerd.exe config default | Out-File config.toml -Encoding ascii + + # 설정을 검토한다. 설정에 따라 다음을 조정할 수 있다. + # - sandbox_image (쿠버네티스 일시중지 이미지) + # - cni bin 폴더와 conf 폴더 위치 + Get-Content config.toml + + # (선택사항 - 그러나 적극 권장함) Windows 디펜더 검사에서 containerd 제외 + Add-MpPreference -ExclusionProcess "$Env:ProgramFiles\containerd\containerd.exe" + ``` + +3. containerd 실행 + + ```powershell + .\containerd.exe --register-service + Start-Service containerd + ``` -```powershell -# containerd 시작 -.\containerd.exe --register-service -Start-Service containerd -``` {{% /tab %}} {{< /tabs >}} -#### systemd {#containerd-systemd} +#### `systemd` cgroup 드라이버의 사용 {#containerd-systemd} `/etc/containerd/config.toml` 의 `systemd` cgroup 드라이버를 `runc` 에서 사용하려면, 다음과 같이 설정한다. @@ -264,6 +157,12 @@ Start-Service containerd SystemdCgroup = true ``` +이 변경 사항을 적용하는 경우 containerd를 재시작한다. + +```shell +sudo systemctl restart containerd +``` + kubeadm을 사용하는 경우, [kubelet용 cgroup 드라이버](/ko/docs/setup/production-environment/tools/kubeadm/install-kubeadm/#컨트롤-플레인-노드에서-kubelet이-사용하는-cgroup-드라이버-구성)를 수동으로 구성한다. @@ -453,138 +352,38 @@ CRI-O의 cgroup 드라이버 구성을 동기화 상태로 ### 도커 -각 노드에 도커 CE를 설치한다. +1. 각 노드에서 [도커 엔진 설치](https://docs.docker.com/engine/install/#server)에 따라 리눅스 배포판용 도커를 설치한다. 이 [의존성 파일](https://git.k8s.io/kubernetes/build/dependencies.yaml)에서 검증된 최신 버전의 도커를 찾을 수 있다. -쿠버네티스 릴리스 정보에서 해당 버전의 쿠버네티스와 호환되는 -도커 버전을 찾을 수 있다. +2. 특히 컨테이너의 cgroup 관리에 systemd를 사용하도록 도커 데몬을 구성한다. -사용자의 시스템에서 다음의 명령을 이용해 도커를 설치한다. + ```shell + sudo mkdir /etc/docker + cat <}} -{{% tab name="Ubuntu 16.04+" %}} + {{< note >}} + `overlay2`는 리눅스 커널 4.0 이상 또는 3.10.0-514 버전 이상을 사용하는 RHEL 또는 CentOS를 구동하는 시스템에서 선호하는 스토리지 드라이버이다. + {{< /note >}} -```shell -# (도커 CE 설치) -## 리포지터리 설정 -### apt가 HTTPS로 리포지터리를 사용하는 것을 허용하기 위한 패키지 설치 -sudo apt-get update && sudo apt-get install -y \ - apt-transport-https ca-certificates curl software-properties-common gnupg2 -``` +3. 도커 재시작과 부팅시 실행되게 설정 -```shell -# 도커 공식 GPG 키 추가: -curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key --keyring /etc/apt/trusted.gpg.d/docker.gpg add - -``` + ```shell + sudo systemctl enable docker + sudo systemctl daemon-reload + sudo systemctl restart docker + ``` -```shell -# 도커 apt 리포지터리 추가: -sudo add-apt-repository \ - "deb [arch=amd64] https://download.docker.com/linux/ubuntu \ - $(lsb_release -cs) \ - stable" -``` - -```shell -# 도커 CE 설치 -sudo apt-get update && sudo apt-get install -y \ - containerd.io=1.2.13-2 \ - docker-ce=5:19.03.11~3-0~ubuntu-$(lsb_release -cs) \ - docker-ce-cli=5:19.03.11~3-0~ubuntu-$(lsb_release -cs) -``` - -```shell -## /etc/docker 생성 -sudo mkdir /etc/docker -``` - -```shell -# 도커 데몬 설정 -cat <}} - -부팅 시 `docker` 서비스를 시작하려면, 다음 명령을 실행한다. - -```shell -sudo systemctl enable docker -``` - -자세한 내용은 [공식 도커 설치 가이드](https://docs.docker.com/engine/installation/)를 -참조한다. +{{< note >}} +더 자세한 내용은 + - [도커 데몬 설정](https://docs.docker.com/config/daemon/) + - [systemd로 도커 제어](https://docs.docker.com/config/daemon/systemd/) +{{< /note >}} diff --git a/content/ko/docs/setup/production-environment/tools/kops.md b/content/ko/docs/setup/production-environment/tools/kops.md index dbea03b735..76c4ec7b32 100644 --- a/content/ko/docs/setup/production-environment/tools/kops.md +++ b/content/ko/docs/setup/production-environment/tools/kops.md @@ -23,7 +23,7 @@ kops는 자동화된 프로비저닝 시스템인데, ## {{% heading "prerequisites" %}} -* [kubectl](/ko/docs/tasks/tools/install-kubectl/)을 반드시 설치해야 한다. +* [kubectl](/ko/docs/tasks/tools/)을 반드시 설치해야 한다. * 반드시 64-bit (AMD64 그리고 Intel 64)디바이스 아키텍쳐 위에서 `kops` 를 [설치](https://github.com/kubernetes/kops#installing) 한다. diff --git a/content/ko/docs/setup/production-environment/tools/kubeadm/install-kubeadm.md b/content/ko/docs/setup/production-environment/tools/kubeadm/install-kubeadm.md index 39f31dd8af..12b48ad17e 100644 --- a/content/ko/docs/setup/production-environment/tools/kubeadm/install-kubeadm.md +++ b/content/ko/docs/setup/production-environment/tools/kubeadm/install-kubeadm.md @@ -159,7 +159,7 @@ kubeadm은 `kubelet` 또는 `kubectl` 을 설치하거나 관리하지 **않으 높을 수 없다. 예를 들어, 1.7.0 버전의 kubelet은 1.8.0 API 서버와 완전히 호환되어야 하지만, 그 반대의 경우는 아니다. -`kubectl` 설치에 대한 정보는 [kubectl 설치 및 설정](/ko/docs/tasks/tools/install-kubectl/)을 참고한다. +`kubectl` 설치에 대한 정보는 [kubectl 설치 및 설정](/ko/docs/tasks/tools/)을 참고한다. {{< warning >}} 이 지침은 모든 시스템 업그레이드에서 모든 쿠버네티스 패키지를 제외한다. @@ -174,16 +174,34 @@ kubeadm은 `kubelet` 또는 `kubectl` 을 설치하거나 관리하지 **않으 {{< tabs name="k8s_install" >}} {{% tab name="데비안 기반 배포판" %}} -```bash -sudo apt-get update && sudo apt-get install -y apt-transport-https curl -curl -s https://packages.cloud.google.com/apt/doc/apt-key.gpg | sudo apt-key add - -cat < diff --git a/content/ko/docs/setup/production-environment/windows/intro-windows-in-kubernetes.md b/content/ko/docs/setup/production-environment/windows/intro-windows-in-kubernetes.md index bd4a3503e8..b488e6c04d 100644 --- a/content/ko/docs/setup/production-environment/windows/intro-windows-in-kubernetes.md +++ b/content/ko/docs/setup/production-environment/windows/intro-windows-in-kubernetes.md @@ -218,7 +218,7 @@ CSI 노드 플러그인(특히 블록 디바이스 또는 공유 파일시스템 #### IPv4/IPv6 이중 스택 -`IPv6DualStack` [기능 게이트](https://kubernetes.io/ko/docs/reference/command-line-tools-reference/feature-gates/)를 사용하여 `l2bridge` 네트워크에 IPv4/IPv6 이중 스택 네트워킹을 활성화할 수 있다. 자세한 내용은 [IPv4/IPv6 이중 스택 활성화](/ko/docs/concepts/services-networking/dual-stack/#ipv4-ipv6-이중-스택-활성화)을 참조한다. +`IPv6DualStack` [기능 게이트](/ko/docs/reference/command-line-tools-reference/feature-gates/)를 사용하여 `l2bridge` 네트워크에 IPv4/IPv6 이중 스택 네트워킹을 활성화할 수 있다. 자세한 내용은 [IPv4/IPv6 이중 스택 활성화](/ko/docs/concepts/services-networking/dual-stack/#ipv4-ipv6-이중-스택-활성화)를 참조한다. {{< note >}} 윈도우에서 쿠버네티스와 함께 IPv6를 사용하려면 윈도우 서버 버전 2004 (커널 버전 10.0.19041.610) 이상이 필요하다. @@ -234,7 +234,7 @@ CSI 노드 플러그인(특히 블록 디바이스 또는 공유 파일시스템 윈도우는 쿠버네티스 아키텍처 및 컴포넌트 매트릭스에서 워커 노드로만 지원된다. 즉, 쿠버네티스 클러스터에는 항상 리눅스 마스터 노드가 반드시 포함되어야 하고, 0개 이상의 리눅스 워커 노드 및 0개 이상의 윈도우 워커 노드가 포함된다. -#### 컴퓨트 +#### 컴퓨트 {#컴퓨트-제한} ##### 리소스 관리 및 프로세스 격리 @@ -294,7 +294,7 @@ CSI 노드 플러그인(특히 블록 디바이스 또는 공유 파일시스템 * NFS 기반 스토리지/볼륨 지원 * 마운트된 볼륨 확장(resizefs) -#### 네트워킹 +#### 네트워킹 {#네트워킹-제한} 윈도우 컨테이너 네트워킹은 리눅스 네트워킹과 몇 가지 중요한 면에서 다르다. [윈도우 컨테이너 네트워킹에 대한 Microsoft 문서](https://docs.microsoft.com/ko-kr/virtualization/windowscontainers/container-networking/architecture)에는 추가 세부 정보와 배경이 포함되어 있다. diff --git a/content/ko/docs/setup/release/notes.md b/content/ko/docs/setup/release/notes.md index 7bcbb39489..8cb17b2ec0 100644 --- a/content/ko/docs/setup/release/notes.md +++ b/content/ko/docs/setup/release/notes.md @@ -1906,7 +1906,7 @@ filename | sha512 hash - Promote SupportNodePidsLimit to GA to provide node to pod pid isolation Promote SupportPodPidsLimit to GA to provide ability to limit pids per pod ([#94140](https://github.com/kubernetes/kubernetes/pull/94140), [@derekwaynecarr](https://github.com/derekwaynecarr)) [SIG Node and Testing] - Rename pod_preemption_metrics to preemption_metrics. ([#93256](https://github.com/kubernetes/kubernetes/pull/93256), [@ahg-g](https://github.com/ahg-g)) [SIG Instrumentation and Scheduling] -- Server-side apply behavior has been regularized in the case where a field is removed from the applied configuration. Removed fields which have no other owners are deleted from the live object, or reset to their default value if they have one. Safe ownership transfers, such as the transfer of a `replicas` field from a user to an HPA without resetting to the default value are documented in [Transferring Ownership](https://kubernetes.io/docs/reference/using-api/api-concepts/#transferring-ownership) ([#92661](https://github.com/kubernetes/kubernetes/pull/92661), [@jpbetz](https://github.com/jpbetz)) [SIG API Machinery, CLI, Cloud Provider, Cluster Lifecycle, Instrumentation and Testing] +- Server-side apply behavior has been regularized in the case where a field is removed from the applied configuration. Removed fields which have no other owners are deleted from the live object, or reset to their default value if they have one. Safe ownership transfers, such as the transfer of a `replicas` field from a user to an HPA without resetting to the default value are documented in [Transferring Ownership](/docs/reference/using-api/server-side-apply/#transferring-ownership) ([#92661](https://github.com/kubernetes/kubernetes/pull/92661), [@jpbetz](https://github.com/jpbetz)) [SIG API Machinery, CLI, Cloud Provider, Cluster Lifecycle, Instrumentation and Testing] - Set CSIMigrationvSphere feature gates to beta. Users should enable CSIMigration + CSIMigrationvSphere features and install the vSphere CSI Driver (https://github.com/kubernetes-sigs/vsphere-csi-driver) to move workload from the in-tree vSphere plugin "kubernetes.io/vsphere-volume" to vSphere CSI Driver. diff --git a/content/ko/docs/tasks/administer-cluster/access-cluster-api.md b/content/ko/docs/tasks/administer-cluster/access-cluster-api.md index b2ea227718..2d44a51b0e 100644 --- a/content/ko/docs/tasks/administer-cluster/access-cluster-api.md +++ b/content/ko/docs/tasks/administer-cluster/access-cluster-api.md @@ -193,7 +193,7 @@ func main() { } ``` -애플리케이션이 클러스터에서 파드로 배치된 경우, [파드 내에서 API 접근](#accessing-the-api-from-within-a-pod)을 참고한다. +애플리케이션이 클러스터 내의 파드로 배치된 경우, [파드 내에서 API 접근](/ko/docs/tasks/access-application-cluster/access-cluster/#파드에서-api-접근)을 참고한다. #### Python 클라이언트 {#python-client} diff --git a/content/ko/docs/tasks/administer-cluster/kubeadm/kubeadm-certs.md b/content/ko/docs/tasks/administer-cluster/kubeadm/kubeadm-certs.md index 272da1e329..487d89379e 100644 --- a/content/ko/docs/tasks/administer-cluster/kubeadm/kubeadm-certs.md +++ b/content/ko/docs/tasks/administer-cluster/kubeadm/kubeadm-certs.md @@ -168,36 +168,7 @@ controllerManager: ### 인증서 서명 요청(CSR) 생성 -`kubeadm certs renew --use-api` 로 쿠버네티스 인증서 API에 대한 인증서 서명 요청을 만들 수 있다. - -[cert-manager](https://github.com/jetstack/cert-manager)와 같은 외부 서명자를 설정하면, 인증서 서명 요청(CSR)이 자동으로 승인된다. -그렇지 않으면, [`kubectl certificate`](/ko/docs/setup/best-practices/certificates/) 명령을 사용하여 인증서를 수동으로 승인해야 한다. -다음의 kubeadm 명령은 승인할 인증서 이름을 출력한 다음, 승인이 발생하기를 차단하고 기다린다. - -```shell -sudo kubeadm certs renew apiserver --use-api & -``` -출력 결과는 다음과 비슷하다. -``` -[1] 2890 -[certs] certificate request "kubeadm-cert-kube-apiserver-ld526" created -``` - -### 인증서 서명 요청(CSR) 승인 - -외부 서명자를 설정하면, 인증서 서명 요청(CSR)이 자동으로 승인된다. - -그렇지 않으면, [`kubectl certificate`](/ko/docs/setup/best-practices/certificates/) 명령을 사용하여 인증서를 수동으로 승인해야 한다. 예를 들어 다음과 같다. - -```shell -kubectl certificate approve kubeadm-cert-kube-apiserver-ld526 -``` -출력 결과는 다음과 비슷하다. -```shell -certificatesigningrequest.certificates.k8s.io/kubeadm-cert-kube-apiserver-ld526 approved -``` - -`kubectl get csr` 명령으로 보류 중인 인증서 목록을 볼 수 있다. +쿠버네티스 API로 CSR을 작성하려면 [CertificateSigningRequest 생성](https://kubernetes.io/docs/reference/access-authn-authz/certificate-signing-requests/#create-certificatesigningrequest)을 본다. ## 외부 CA로 인증서 갱신 diff --git a/content/ko/docs/tasks/manage-kubernetes-objects/declarative-config.md b/content/ko/docs/tasks/manage-kubernetes-objects/declarative-config.md index 26fa2830ff..f7dcbab677 100644 --- a/content/ko/docs/tasks/manage-kubernetes-objects/declarative-config.md +++ b/content/ko/docs/tasks/manage-kubernetes-objects/declarative-config.md @@ -16,7 +16,7 @@ weight: 10 ## {{% heading "prerequisites" %}} -[`kubectl`](/ko/docs/tasks/tools/install-kubectl/)를 설치한다. +[`kubectl`](/ko/docs/tasks/tools/)를 설치한다. {{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} diff --git a/content/ko/docs/tasks/manage-kubernetes-objects/imperative-command.md b/content/ko/docs/tasks/manage-kubernetes-objects/imperative-command.md index 28655ed57b..8b4d5afe36 100644 --- a/content/ko/docs/tasks/manage-kubernetes-objects/imperative-command.md +++ b/content/ko/docs/tasks/manage-kubernetes-objects/imperative-command.md @@ -12,7 +12,7 @@ weight: 30 ## {{% heading "prerequisites" %}} -[`kubectl`](/ko/docs/tasks/tools/install-kubectl/)을 설치한다. +[`kubectl`](/ko/docs/tasks/tools/)을 설치한다. {{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} diff --git a/content/ko/docs/tasks/manage-kubernetes-objects/imperative-config.md b/content/ko/docs/tasks/manage-kubernetes-objects/imperative-config.md index 9e4f8de774..678814de3d 100644 --- a/content/ko/docs/tasks/manage-kubernetes-objects/imperative-config.md +++ b/content/ko/docs/tasks/manage-kubernetes-objects/imperative-config.md @@ -13,7 +13,7 @@ weight: 40 ## {{% heading "prerequisites" %}} -[`kubectl`](/ko/docs/tasks/tools/install-kubectl/)을 설치한다. +[`kubectl`](/ko/docs/tasks/tools/)을 설치한다. {{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} diff --git a/content/ko/docs/tasks/manage-kubernetes-objects/kustomization.md b/content/ko/docs/tasks/manage-kubernetes-objects/kustomization.md index 16b2cd05f0..e420acbed9 100644 --- a/content/ko/docs/tasks/manage-kubernetes-objects/kustomization.md +++ b/content/ko/docs/tasks/manage-kubernetes-objects/kustomization.md @@ -29,7 +29,7 @@ kubectl apply -k ## {{% heading "prerequisites" %}} -[`kubectl`](/ko/docs/tasks/tools/install-kubectl/)을 설치한다. +[`kubectl`](/ko/docs/tasks/tools/)을 설치한다. {{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} diff --git a/content/ko/docs/tasks/tools/install-kubectl-linux.md b/content/ko/docs/tasks/tools/install-kubectl-linux.md index 0e8a6ac6ee..96ab0a4024 100644 --- a/content/ko/docs/tasks/tools/install-kubectl-linux.md +++ b/content/ko/docs/tasks/tools/install-kubectl-linux.md @@ -20,10 +20,16 @@ card: 다음과 같은 방법으로 리눅스에 kubectl을 설치할 수 있다. -- [리눅스에서 curl을 사용하여 kubectl 바이너리 설치](#install-kubectl-binary-with-curl-on-linux) -- [기본 패키지 관리 도구를 사용하여 설치](#install-using-native-package-management) -- [다른 패키지 관리 도구를 사용하여 설치](#install-using-other-package-management) -- [Google Cloud SDK를 사용하여 설치](#install-on-linux-as-part-of-the-google-cloud-sdk) +- [{{% heading "prerequisites" %}}](#시작하기-전에) +- [리눅스에 kubectl 설치](#리눅스에-kubectl-설치) + - [리눅스에서 curl을 사용하여 kubectl 바이너리 설치]{#install-kubectl-binary-with-curl-on-linux} + - [기본 패키지 관리 도구를 사용하여 설치]{#install-using-native-package-management} + - [다른 패키지 관리 도구를 사용하여 설치]{#install-using-other-package-management} + - [Google Cloud SDK를 사용하여 설치]{#install-on-linux-as-part-of-the-google-cloud-sdk} +- [kubectl 구성 확인](#kubectl-구성-확인) +- [선택적 kubectl 구성](#선택적-kubectl-구성) + - [셸 자동 완성 활성화](#셸-자동-완성-활성화) +- [{{% heading "whatsnext" %}}](#다음-내용) ### 리눅스에서 curl을 사용하여 kubectl 바이너리 설치 {#install-kubectl-binary-with-curl-on-linux} @@ -100,15 +106,38 @@ card: ### 기본 패키지 관리 도구를 사용하여 설치 {#install-using-native-package-management} {{< tabs name="kubectl_install" >}} -{{< tab name="Ubuntu, Debian 또는 HypriotOS" codelang="bash" >}} -sudo apt-get update && sudo apt-get install -y apt-transport-https gnupg2 curl -curl -s https://packages.cloud.google.com/apt/doc/apt-key.gpg | sudo apt-key add - -echo "deb https://apt.kubernetes.io/ kubernetes-xenial main" | sudo tee -a /etc/apt/sources.list.d/kubernetes.list -sudo apt-get update -sudo apt-get install -y kubectl -{{< /tab >}} +{{% tab name="데비안 기반의 배포판" %}} -{{< tab name="CentOS, RHEL 또는 Fedora" codelang="bash" >}}cat < /etc/yum.repos.d/kubernetes.repo +1. `apt` 패키지 색인을 업데이트하고 쿠버네티스 `apt` 리포지터리를 사용하는 데 필요한 패키지들을 설치한다. + + ```shell + sudo apt-get update + sudo apt-get install -y apt-transport-https ca-certificates curl + ``` + +2. 구글 클라우드 공개 사이닝 키를 다운로드한다. + + ```shell + sudo curl -fsSLo /usr/share/keyrings/kubernetes-archive-keyring.gpg https://packages.cloud.google.com/apt/doc/apt-key.gpg + ``` + +3. 쿠버네티스 `apt` 리포지터리를 추가한다. + + ```shell + echo "deb [signed-by=/usr/share/keyrings/kubernetes-archive-keyring.gpg] https://apt.kubernetes.io/ kubernetes-xenial main" | sudo tee /etc/apt/sources.list.d/kubernetes.list + ``` + +4. 새 리포지터리의 `apt` 패키지 색인을 업데이트하고 kubectl을 설치한다. + + ```shell + sudo apt-get update + sudo apt-get install -y kubectl + ``` + +{{% /tab %}} + +{{< tab name="레드햇 기반의 배포판" codelang="bash" >}} +cat < /etc/yum.repos.d/kubernetes.repo [kubernetes] name=Kubernetes baseurl=https://packages.cloud.google.com/yum/repos/kubernetes-el7-x86_64 diff --git a/content/ko/docs/tasks/tools/install-kubectl-macos.md b/content/ko/docs/tasks/tools/install-kubectl-macos.md index b0747f8a1c..1fd37151a6 100644 --- a/content/ko/docs/tasks/tools/install-kubectl-macos.md +++ b/content/ko/docs/tasks/tools/install-kubectl-macos.md @@ -23,7 +23,7 @@ card: - [macOS에서 curl을 사용하여 kubectl 바이너리 설치](#install-kubectl-binary-with-curl-on-macos) - [macOS에서 Homebrew를 사용하여 설치](#install-with-homebrew-on-macos) - [macOS에서 Macports를 사용하여 설치](#install-with-macports-on-macos) -- [Google Cloud SDK를 사용하여 설치](#install-on-macos-as-part-of-the-google-cloud-sdk) +- [macOS에서 Google Cloud SDK를 사용하여 설치](#install-on-macos-as-part-of-the-google-cloud-sdk) ### macOS에서 curl을 사용하여 kubectl 바이너리 설치 {#install-kubectl-binary-with-curl-on-macos} @@ -157,4 +157,4 @@ kubectl은 Bash 및 Zsh에 대한 자동 완성 지원을 제공하므로 입력 ## {{% heading "whatsnext" %}} -{{< include "included/kubectl-whats-next.md" >}} \ No newline at end of file +{{< include "included/kubectl-whats-next.md" >}} From e172a7e26405058fa1e5ac01645e6cf41c809020 Mon Sep 17 00:00:00 2001 From: jmyung Date: Fri, 26 Mar 2021 00:41:53 +0900 Subject: [PATCH 086/104] translate Manage TLS Certificates in a Cluster in Korean --- .../tasks/tls/managing-tls-in-a-cluster.md | 226 ++++++++++++++++++ 1 file changed, 226 insertions(+) create mode 100644 content/ko/docs/tasks/tls/managing-tls-in-a-cluster.md diff --git a/content/ko/docs/tasks/tls/managing-tls-in-a-cluster.md b/content/ko/docs/tasks/tls/managing-tls-in-a-cluster.md new file mode 100644 index 0000000000..f814db9919 --- /dev/null +++ b/content/ko/docs/tasks/tls/managing-tls-in-a-cluster.md @@ -0,0 +1,226 @@ +--- +title: 클러스터에서 TLS 인증서 관리 +content_type: task +--- + + + +쿠버네티스는 사용자가 제어하는 ​​인증 기관 (CA)에서 서명한 TLS 인증서를 +프로비저닝 할 수 있는 `certificates.k8s.io` API를 제공한다. +이러한 CA 및 인증서는 워크로드 간의 신뢰 관계를 구성하는 용도로 사용할 수 있다. + +`certificates.k8s.io` API는 [ACME 초안](https://github.com/ietf-wg-acme/acme/)과 +유사한 프로토콜을 사용한다. + +{{< note >}} +`certificates.k8s.io` API를 사용하여 생성된 인증서는 전용 CA로 서명된다. +이러한 목적을 위해 클러스터 루트 CA를 사용하도록 클러스터를 +구성할 수 있지만, 절대 이에 의존해서는 안된다. +해당 인증서가 클러스터 루트 CA에 대해 유효성을 검사한다고 가정하면 안된다. +{{< /note >}} + + + + +## {{% heading "prerequisites" %}} + + +{{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} + + + + + +## 클러스터에서 TLS 신뢰 + +파드로 실행되는 애플리케이션에서 사용자 정의 CA를 신뢰하려면 +일반적으로 몇 가지 추가 애플리케이션 구성이 필요하다. +TLS 클라이언트 또는 서버가 신뢰하는 CA 인증서 목록에 +CA 인증서 번들을 추가해야 한다. +예를 들어 인증서 체인을 파싱하고, 파싱된 인증서를 [`tls.Config`](https://godoc.org/crypto/tls#Config) 구조체의 +`RootCAs` 필드에 추가하여, golang TLS 구성으로 이를 수행할 수 있다. + +CA 인증서를 파드에서 사용할 수 있는 +[ConfigMap](/docs/tasks/configure-pod-container/configure-pod-configmap)으로 +배포할 수 있다. + +## 인증서 요청 + +다음 섹션에서는 DNS를 통해 액세스되는 쿠버네티스 서비스의 +TLS 인증서를 생성하는 방법을 보여준다. + +{{< note >}} +이 튜토리얼에서는 CFSSL을 사용한다. [여기를 클릭](https://blog.cloudflare.com/introducing-cfssl/)하여 Cloudflare의 PKI 및 TLS 툴킷을 자세히 알아본다. +{{< /note >}} + +## CFSSL 다운로드 및 설치 + +이 예제에 사용된 cfssl 도구는 +[https://github.com/cloudflare/cfssl/releases](https://github.com/cloudflare/cfssl/releases)에서 다운로드 할 수 있다. + +## 인증서 서명 요청 (CSR) 생성 + +다음 명령을 실행하여 개인 키 및 인증서 서명 요청(또는 CSR)을 +생성한다. + +```shell +cat < +Annotations: +CreationTimestamp: Tue, 21 Mar 2017 07:03:51 -0700 +Requesting User: yourname@example.com +Status: Pending +Subject: + Common Name: my-svc.my-namespace.svc.cluster.local + Serial Number: +Subject Alternative Names: + DNS Names: my-svc.my-namespace.svc.cluster.local + IP Addresses: 192.0.2.24 + 10.0.34.2 +Events: +``` + +## 인증서 서명 요청 승인 받기 + +인증서 서명 요청을 승인하는 것은 자동화된 승인 프로세스나 +클러스터 관리자에 의해 일회성으로 수행한다. 여기에 +관련된 내용에 대한 자세한 내용은 아래에서 설명한다. + +## 인증서 다운로드 및 사용 + +CSR이 서명되고 승인되면 다음이 표시된다. + +```shell +kubectl get csr +``` + +```none +NAME AGE REQUESTOR CONDITION +my-svc.my-namespace 10m yourname@example.com Approved,Issued +``` + +다음을 실행하여 발급된 인증서를 다운로드하고 `server.crt` 파일에 +저장할 수 있다. + +```shell +kubectl get csr my-svc.my-namespace -o jsonpath='{.status.certificate}' \ + | base64 --decode > server.crt +``` + +이제 `server.crt` 및 `server-key.pem`을 키페어(keypair)로 사용하여 +HTTPS 서버를 시작할 수 있다. + +## 인증서 서명 요청 승인 + +(적절한 권한이 있는) 쿠버네티스 관리자는 +`kubectl certificate approve` 과 `kubectl certificate deny` +명령을 사용하여 인증서 서명 요청을 수동으로 승인 (또는 거부) 할 수 있다. +그러나 이 API를 많이 사용한다면, +자동화된 인증서 컨트롤러 작성을 고려할 수 있다. + +위와 같이 kubectl을 사용하는 시스템이든 사람이든, 승인자의 역할은 +CSR이 다음 두 가지 요구 사항을 충족하는지 확인하는 것이다. + +1. CSR은 CSR에 서명하는 데 사용되는 개인 키를 제어하는 것이다. 이는 + 승인된 대상으로 가장하는 제 3자의 위협을 해결한다. 위의 예에서 + 이 단계는 파드(pod)가 CSR을 생성하는 데 + 사용되는 개인 키를 제어하는지 확인하는 것이다. +2. CSR은 요청된 상황에서 작동할 권한이 있다. 이것은 + 원하지 않는 대상이 클러스터에 합류(join)하는 위협을 + 해결한다. 위의 예에서, 이 단계는 + 파드가 요청된 서비스에 참여할 수 있는지 확인하는 것이다. + +이 두 가지 요구 사항이 충족되는 경우에만, 승인자가 CSR을 승인하고 +그렇지 않으면 CSR을 거부해야 한다. + +## 승인 허가에 대한 경고문 + +CSR을 승인하는 능력은 환경 내에서 누구를 신뢰하는지 결정한다. CSR 승인 +능력은 광범위하거나 가볍게 부여해서는 안된다. 이 권한을 +부여하기 전에 이전 섹션에서 언급한 +요청의 요구 사항과 특정 인증서 발급의 영향을 +완전히 이해해야 한다. + +## 클러스터 관리자를 위한 참고 사항 + +이 가이드에서는 서명자가 인증서 API를 제공하도록 설정되었다고 가정한다. 쿠버네티스 +컨트롤러 관리자는 서명자의 기본 구현을 제공한다. 이를 +활성화하려면 인증 기관(CA)의 키 쌍에 대한 경로와 함께 `--cluster-signing-cert-file` 와 +`--cluster-signing-key-file` 매개 변수를 +컨트롤러 관리자에 전달한다. From c8d20ea228f35d2e28c8f1e23529abe27a8a7dc8 Mon Sep 17 00:00:00 2001 From: Luo Lan Date: Thu, 1 Apr 2021 21:31:22 +0800 Subject: [PATCH 087/104] update antrea link based on review comment --- content/en/docs/concepts/cluster-administration/addons.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/concepts/cluster-administration/addons.md b/content/en/docs/concepts/cluster-administration/addons.md index e194674d59..726a714151 100644 --- a/content/en/docs/concepts/cluster-administration/addons.md +++ b/content/en/docs/concepts/cluster-administration/addons.md @@ -16,7 +16,7 @@ This page lists some of the available add-ons and links to their respective inst ## Networking and Network Policy * [ACI](https://www.github.com/noironetworks/aci-containers) provides integrated container networking and network security with Cisco ACI. -* [Antrea](https://github.com/vmware-tanzu/antrea) operates at Layer 3/4 to provide networking and security services for Kubernetes, leveraging Open vSwitch as the networking data plane. +* [Antrea](https://antrea.io/) operates at Layer 3/4 to provide networking and security services for Kubernetes, leveraging Open vSwitch as the networking data plane. * [Calico](https://docs.projectcalico.org/latest/introduction/) is a networking and network policy provider. Calico supports a flexible set of networking options so you can choose the most efficient option for your situation, including non-overlay and overlay networks, with or without BGP. Calico uses the same engine to enforce network policy for hosts, pods, and (if using Istio & Envoy) applications at the service mesh layer. * [Canal](https://github.com/tigera/canal/tree/master/k8s-install) unites Flannel and Calico, providing networking and network policy. * [Cilium](https://github.com/cilium/cilium) is a L3 network and network policy plugin that can enforce HTTP/API/L7 policies transparently. Both routing and overlay/encapsulation mode are supported, and it can work on top of other CNI plugins. From 79845b0c4aa0bba3752496c5e2a394b7929564ce Mon Sep 17 00:00:00 2001 From: Qiming Teng Date: Wed, 17 Feb 2021 16:50:15 +0800 Subject: [PATCH 088/104] Add kubelet config reference This is a reference for kubelet config generated from github.com/tengqm/genref tool using the following command: ./genref -include kubelet-config --- .../docs/concepts/configuration/configmap.md | 3 +- .../manage-resources-containers.md | 8 +- .../en/docs/concepts/configuration/secret.md | 16 +- content/en/docs/reference/_index.md | 8 +- .../kubelet-config.v1beta1.md | 1501 +++++++++++++++ .../kubelet-tls-bootstrapping.md | 54 +- .../config-api/kubelet-config.v1beta1.md | 1604 +++++++++++++++++ .../kubeadm/implementation-details.md | 25 +- .../tools/kubeadm/install-kubeadm.md | 8 +- .../tools/kubeadm/kubelet-integration.md | 25 +- .../tools/kubeadm/troubleshooting-kubeadm.md | 17 +- .../administer-cluster/kubelet-config-file.md | 22 +- .../administer-cluster/reconfigure-kubelet.md | 46 +- .../configure-pod-container/static-pod.md | 28 +- 14 files changed, 3248 insertions(+), 117 deletions(-) create mode 100644 content/en/docs/reference/command-line-tools-reference/kubelet-config.v1beta1.md create mode 100644 content/en/docs/reference/config-api/kubelet-config.v1beta1.md diff --git a/content/en/docs/concepts/configuration/configmap.md b/content/en/docs/concepts/configuration/configmap.md index 74281e1ec1..b5f5bd8d28 100644 --- a/content/en/docs/concepts/configuration/configmap.md +++ b/content/en/docs/concepts/configuration/configmap.md @@ -224,7 +224,7 @@ When a ConfigMap currently consumed in a volume is updated, projected keys are e The kubelet checks whether the mounted ConfigMap is fresh on every periodic sync. However, the kubelet uses its local cache for getting the current value of the ConfigMap. The type of the cache is configurable using the `ConfigMapAndSecretChangeDetectionStrategy` field in -the [KubeletConfiguration struct](https://github.com/kubernetes/kubernetes/blob/{{< param "docsbranch" >}}/staging/src/k8s.io/kubelet/config/v1beta1/types.go). +the [KubeletConfiguration struct](/docs/reference/config-api/kubelet-config.v1beta1/)). A ConfigMap can be either propagated by watch (default), ttl-based, or by redirecting all requests directly to the API server. As a result, the total delay from the moment when the ConfigMap is updated to the moment @@ -233,6 +233,7 @@ propagation delay, where the cache propagation delay depends on the chosen cache (it equals to watch propagation delay, ttl of cache, or zero correspondingly). ConfigMaps consumed as environment variables are not updated automatically and require a pod restart. + ## Immutable ConfigMaps {#configmap-immutable} {{< feature-state for_k8s_version="v1.19" state="beta" >}} diff --git a/content/en/docs/concepts/configuration/manage-resources-containers.md b/content/en/docs/concepts/configuration/manage-resources-containers.md index fa683e97f3..48b6868bde 100644 --- a/content/en/docs/concepts/configuration/manage-resources-containers.md +++ b/content/en/docs/concepts/configuration/manage-resources-containers.md @@ -21,9 +21,6 @@ allowed to use more of that resource than the limit you set. The kubelet also re at least the _request_ amount of that system resource specifically for that container to use. - - - ## Requests and limits @@ -442,12 +439,15 @@ If you want to use project quotas, you should: * Enable the `LocalStorageCapacityIsolationFSQuotaMonitoring=true` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/) - in the kubelet configuration. + using the `featureGates` field in the + [kubelet configuration](/docs/reference/config-api/kubelet-config.v1beta1/) + or the `--feature-gates` command line flag. * Ensure that the root filesystem (or optional runtime filesystem) has project quotas enabled. All XFS filesystems support project quotas. For ext4 filesystems, you need to enable the project quota tracking feature while the filesystem is not mounted. + ```bash # For ext4, with /dev/block-device not mounted sudo tune2fs -O project -Q prjquota /dev/block-device diff --git a/content/en/docs/concepts/configuration/secret.md b/content/en/docs/concepts/configuration/secret.md index 7f47aeeaf5..d41c7eacf9 100644 --- a/content/en/docs/concepts/configuration/secret.md +++ b/content/en/docs/concepts/configuration/secret.md @@ -668,7 +668,7 @@ When a secret currently consumed in a volume is updated, projected keys are even The kubelet checks whether the mounted secret is fresh on every periodic sync. However, the kubelet uses its local cache for getting the current value of the Secret. The type of the cache is configurable using the `ConfigMapAndSecretChangeDetectionStrategy` field in -the [KubeletConfiguration struct](https://github.com/kubernetes/kubernetes/blob/{{< param "docsbranch" >}}/staging/src/k8s.io/kubelet/config/v1beta1/types.go). +the [KubeletConfiguration struct](/docs/reference/config-api/kubelet-config.v1beta1/). A Secret can be either propagated by watch (default), ttl-based, or by redirecting all requests directly to the API server. As a result, the total delay from the moment when the Secret is updated to the moment @@ -760,8 +760,8 @@ data has the following advantages: - improves performance of your cluster by significantly reducing load on kube-apiserver, by closing watches for secrets marked as immutable. -This feature is controlled by the `ImmutableEphemeralVolumes` [feature -gate](/docs/reference/command-line-tools-reference/feature-gates/), +This feature is controlled by the `ImmutableEphemeralVolumes` +[feature gate](/docs/reference/command-line-tools-reference/feature-gates/), which is enabled by default since v1.19. You can create an immutable Secret by setting the `immutable` field to `true`. For example, ```yaml @@ -865,6 +865,7 @@ start until all the Pod's volumes are mounted. ### Use-Case: As container environment variables Create a secret + ```yaml apiVersion: v1 kind: Secret @@ -877,6 +878,7 @@ data: ``` Create the Secret: + ```shell kubectl apply -f mysecret.yaml ``` @@ -992,7 +994,7 @@ For example, if your actual password is `S!B\*d$zDsb=`, you should execute the c kubectl create secret generic dev-db-secret --from-literal=username=devuser --from-literal=password='S!B\*d$zDsb=' ``` - You do not need to escape special characters in passwords from files (`--from-file`). +You do not need to escape special characters in passwords from files (`--from-file`). {{< /note >}} Now make the Pods: @@ -1173,14 +1175,12 @@ privileged, system-level components. Applications that need to access the Secret API should perform `get` requests on the secrets they need. This lets administrators restrict access to all secrets -while [white-listing access to individual instances]( -/docs/reference/access-authn-authz/rbac/#referring-to-resources) that +while [white-listing access to individual instances](/docs/reference/access-authn-authz/rbac/#referring-to-resources) that the app needs. For improved performance over a looping `get`, clients can design resources that reference a secret then `watch` the resource, re-requesting the secret when the -reference changes. Additionally, a ["bulk watch" API]( -https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/bulk_watch.md) +reference changes. Additionally, a ["bulk watch" API](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/bulk_watch.md) to let clients `watch` individual resources has also been proposed, and will likely be available in future releases of Kubernetes. diff --git a/content/en/docs/reference/_index.md b/content/en/docs/reference/_index.md index 00adcad7d7..c4792c079c 100644 --- a/content/en/docs/reference/_index.md +++ b/content/en/docs/reference/_index.md @@ -51,7 +51,9 @@ client libraries: ## Components -* [kubelet](/docs/reference/command-line-tools-reference/kubelet/) - The primary *node agent* that runs on each node. The kubelet takes a set of PodSpecs and ensures that the described containers are running and healthy. +* [kubelet](/docs/reference/command-line-tools-reference/kubelet/) - The + primary agent that runs on each node. The kubelet takes a set of PodSpecs + and ensures that the described containers are running and healthy. * [kube-apiserver](/docs/reference/command-line-tools-reference/kube-apiserver/) - REST API that validates and configures data for API objects such as pods, services, replication controllers. * [kube-controller-manager](/docs/reference/command-line-tools-reference/kube-controller-manager/) - Daemon that embeds the core control loops shipped with Kubernetes. * [kube-proxy](/docs/reference/command-line-tools-reference/kube-proxy/) - Can @@ -66,6 +68,10 @@ client libraries: * [kube-proxy configuration (v1alpha1)](/docs/reference/config-api/kube-proxy-config.v1alpha1/) +## Config APIs + +* [kubelet config (v1beta1)](/docs/reference/config-api/kubelet-config.v1beta1/) + ## Design Docs An archive of the design docs for Kubernetes functionality. Good starting points are diff --git a/content/en/docs/reference/command-line-tools-reference/kubelet-config.v1beta1.md b/content/en/docs/reference/command-line-tools-reference/kubelet-config.v1beta1.md new file mode 100644 index 0000000000..a5e28a1043 --- /dev/null +++ b/content/en/docs/reference/command-line-tools-reference/kubelet-config.v1beta1.md @@ -0,0 +1,1501 @@ + + + + + +--- +title: kubelet.config.k8s.io/v1beta1 +content_type: tool-reference +--- + + +## Resource Types + + + +- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration) +- [SerializedNodeConfigSource](#kubelet-config-k8s-io-v1beta1-SerializedNodeConfigSource) + + + + + +### `KubeletConfiguration` {#kubelet-config-k8s-io-v1beta1-KubeletConfiguration} + + + + + +KubeletConfiguration contains the configuration for the Kubelet + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    kubelet.config.k8s.io/v1beta1
    kind
    string
    KubeletConfiguration
    enableServer*
    +bool +
    enableServer enables Kubelet's secured server. +Note: Kubelet's insecure port is controlled by the readOnlyPort option. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may disrupt components that interact with the Kubelet server. +Default: true
    staticPodPath
    +string +
    staticPodPath is the path to the directory containing local (static) pods to +run, or the path to a single static pod file. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +the set of static pods specified at the new path may be different than the +ones the Kubelet initially started with, and this may disrupt your node. +Default: ""
    syncFrequency
    +meta/v1.Duration +
    syncFrequency is the max period between synchronizing running +containers and config. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +shortening this duration may have a negative performance impact, especially +as the number of Pods on the node increases. Alternatively, increasing this +duration will result in longer refresh times for ConfigMaps and Secrets. +Default: "1m"
    fileCheckFrequency
    +meta/v1.Duration +
    fileCheckFrequency is the duration between checking config files for +new data +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +shortening the duration will cause the Kubelet to reload local Static Pod +configurations more frequently, which may have a negative performance impact. +Default: "20s"
    httpCheckFrequency
    +meta/v1.Duration +
    httpCheckFrequency is the duration between checking http for new data +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +shortening the duration will cause the Kubelet to poll staticPodURL more +frequently, which may have a negative performance impact. +Default: "20s"
    staticPodURL
    +string +
    staticPodURL is the URL for accessing static pods to run +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +the set of static pods specified at the new URL may be different than the +ones the Kubelet initially started with, and this may disrupt your node. +Default: ""
    staticPodURLHeader
    +map[string][]string +
    staticPodURLHeader is a map of slices with HTTP headers to use when accessing the podURL +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may disrupt the ability to read the latest set of static pods from StaticPodURL. +Default: nil
    address
    +string +
    address is the IP address for the Kubelet to serve on (set to 0.0.0.0 +for all interfaces). +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may disrupt components that interact with the Kubelet server. +Default: "0.0.0.0"
    port
    +int32 +
    port is the port for the Kubelet to serve on. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may disrupt components that interact with the Kubelet server. +Default: 10250
    readOnlyPort
    +int32 +
    readOnlyPort is the read-only port for the Kubelet to serve on with +no authentication/authorization. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may disrupt components that interact with the Kubelet server. +Default: 0 (disabled)
    tlsCertFile
    +string +
    tlsCertFile is the file containing x509 Certificate for HTTPS. (CA cert, +if any, concatenated after server cert). If tlsCertFile and +tlsPrivateKeyFile are not provided, a self-signed certificate +and key are generated for the public address and saved to the directory +passed to the Kubelet's --cert-dir flag. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may disrupt components that interact with the Kubelet server. +Default: ""
    tlsPrivateKeyFile
    +string +
    tlsPrivateKeyFile is the file containing x509 private key matching tlsCertFile +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may disrupt components that interact with the Kubelet server. +Default: ""
    tlsCipherSuites
    +[]string +
    TLSCipherSuites is the list of allowed cipher suites for the server. +Values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may disrupt components that interact with the Kubelet server. +Default: nil
    tlsMinVersion
    +string +
    TLSMinVersion is the minimum TLS version supported. +Values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may disrupt components that interact with the Kubelet server. +Default: ""
    rotateCertificates
    +bool +
    rotateCertificates enables client certificate rotation. The Kubelet will request a +new certificate from the certificates.k8s.io API. This requires an approver to approve the +certificate signing requests. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +disabling it may disrupt the Kubelet's ability to authenticate with the API server +after the current certificate expires. +Default: false
    serverTLSBootstrap
    +bool +
    serverTLSBootstrap enables server certificate bootstrap. Instead of self +signing a serving certificate, the Kubelet will request a certificate from +the certificates.k8s.io API. This requires an approver to approve the +certificate signing requests. The RotateKubeletServerCertificate feature +must be enabled. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +disabling it will stop the renewal of Kubelet server certificates, which can +disrupt components that interact with the Kubelet server in the long term, +due to certificate expiration. +Default: false
    authentication
    +KubeletAuthentication +
    authentication specifies how requests to the Kubelet's server are authenticated +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may disrupt components that interact with the Kubelet server. +Defaults: + anonymous: + enabled: false + webhook: + enabled: true + cacheTTL: "2m"
    authorization
    +KubeletAuthorization +
    authorization specifies how requests to the Kubelet's server are authorized +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may disrupt components that interact with the Kubelet server. +Defaults: + mode: Webhook + webhook: + cacheAuthorizedTTL: "5m" + cacheUnauthorizedTTL: "30s"
    registryPullQPS
    +int32 +
    registryPullQPS is the limit of registry pulls per second. +Set to 0 for no limit. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may impact scalability by changing the amount of traffic produced +by image pulls. +Default: 5
    registryBurst
    +int32 +
    registryBurst is the maximum size of bursty pulls, temporarily allows +pulls to burst to this number, while still not exceeding registryPullQPS. +Only used if registryPullQPS > 0. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may impact scalability by changing the amount of traffic produced +by image pulls. +Default: 10
    eventRecordQPS
    +int32 +
    eventRecordQPS is the maximum event creations per second. If 0, there +is no limit enforced. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may impact scalability by changing the amount of traffic produced by +event creations. +Default: 5
    eventBurst
    +int32 +
    eventBurst is the maximum size of a burst of event creations, temporarily +allows event creations to burst to this number, while still not exceeding +eventRecordQPS. Only used if eventRecordQPS > 0. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may impact scalability by changing the amount of traffic produced by +event creations. +Default: 10
    enableDebuggingHandlers
    +bool +
    enableDebuggingHandlers enables server endpoints for log access +and local running of containers and commands, including the exec, +attach, logs, and portforward features. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +disabling it may disrupt components that interact with the Kubelet server. +Default: true
    enableContentionProfiling
    +bool +
    enableContentionProfiling enables lock contention profiling, if enableDebuggingHandlers is true. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +enabling it may carry a performance impact. +Default: false
    healthzPort
    +int32 +
    healthzPort is the port of the localhost healthz endpoint (set to 0 to disable) +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may disrupt components that monitor Kubelet health. +Default: 10248
    healthzBindAddress
    +string +
    healthzBindAddress is the IP address for the healthz server to serve on +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may disrupt components that monitor Kubelet health. +Default: "127.0.0.1"
    oomScoreAdj
    +int32 +
    oomScoreAdj is The oom-score-adj value for kubelet process. Values +must be within the range [-1000, 1000]. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may impact the stability of nodes under memory pressure. +Default: -999
    clusterDomain
    +string +
    clusterDomain is the DNS domain for this cluster. If set, kubelet will +configure all containers to search this domain in addition to the +host's search domains. +Dynamic Kubelet Config (beta): Dynamically updating this field is not recommended, +as it should be kept in sync with the rest of the cluster. +Default: ""
    clusterDNS
    +[]string +
    clusterDNS is a list of IP addresses for the cluster DNS server. If set, +kubelet will configure all containers to use this for DNS resolution +instead of the host's DNS servers. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +changes will only take effect on Pods created after the update. Draining +the node is recommended before changing this field. +Default: nil
    streamingConnectionIdleTimeout
    +meta/v1.Duration +
    streamingConnectionIdleTimeout is the maximum time a streaming connection +can be idle before the connection is automatically closed. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may impact components that rely on infrequent updates over streaming +connections to the Kubelet server. +Default: "4h"
    nodeStatusUpdateFrequency
    +meta/v1.Duration +
    nodeStatusUpdateFrequency is the frequency that kubelet computes node +status. If node lease feature is not enabled, it is also the frequency that +kubelet posts node status to master. +Note: When node lease feature is not enabled, be cautious when changing the +constant, it must work with nodeMonitorGracePeriod in nodecontroller. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may impact node scalability, and also that the node controller's +nodeMonitorGracePeriod must be set to N∗NodeStatusUpdateFrequency, +where N is the number of retries before the node controller marks +the node unhealthy. +Default: "10s"
    nodeStatusReportFrequency
    +meta/v1.Duration +
    nodeStatusReportFrequency is the frequency that kubelet posts node +status to master if node status does not change. Kubelet will ignore this +frequency and post node status immediately if any change is detected. It is +only used when node lease feature is enabled. nodeStatusReportFrequency's +default value is 1m. But if nodeStatusUpdateFrequency is set explicitly, +nodeStatusReportFrequency's default value will be set to +nodeStatusUpdateFrequency for backward compatibility. +Default: "1m"
    nodeLeaseDurationSeconds
    +int32 +
    nodeLeaseDurationSeconds is the duration the Kubelet will set on its corresponding Lease, +when the NodeLease feature is enabled. This feature provides an indicator of node +health by having the Kubelet create and periodically renew a lease, named after the node, +in the kube-node-lease namespace. If the lease expires, the node can be considered unhealthy. +The lease is currently renewed every 10s, per KEP-0009. In the future, the lease renewal interval +may be set based on the lease duration. +Requires the NodeLease feature gate to be enabled. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +decreasing the duration may reduce tolerance for issues that temporarily prevent +the Kubelet from renewing the lease (e.g. a short-lived network issue). +Default: 40
    imageMinimumGCAge
    +meta/v1.Duration +
    imageMinimumGCAge is the minimum age for an unused image before it is +garbage collected. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may trigger or delay garbage collection, and may change the image overhead +on the node. +Default: "2m"
    imageGCHighThresholdPercent
    +int32 +
    imageGCHighThresholdPercent is the percent of disk usage after which +image garbage collection is always run. The percent is calculated as +this field value out of 100. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may trigger or delay garbage collection, and may change the image overhead +on the node. +Default: 85
    imageGCLowThresholdPercent
    +int32 +
    imageGCLowThresholdPercent is the percent of disk usage before which +image garbage collection is never run. Lowest disk usage to garbage +collect to. The percent is calculated as this field value out of 100. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may trigger or delay garbage collection, and may change the image overhead +on the node. +Default: 80
    volumeStatsAggPeriod
    +meta/v1.Duration +
    How frequently to calculate and cache volume disk usage for all pods +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +shortening the period may carry a performance impact. +Default: "1m"
    kubeletCgroups
    +string +
    kubeletCgroups is the absolute name of cgroups to isolate the kubelet in +Dynamic Kubelet Config (beta): This field should not be updated without a full node +reboot. It is safest to keep this value the same as the local config. +Default: ""
    systemCgroups
    +string +
    systemCgroups is absolute name of cgroups in which to place +all non-kernel processes that are not already in a container. Empty +for no container. Rolling back the flag requires a reboot. +Dynamic Kubelet Config (beta): This field should not be updated without a full node +reboot. It is safest to keep this value the same as the local config. +Default: ""
    cgroupRoot
    +string +
    cgroupRoot is the root cgroup to use for pods. This is handled by the +container runtime on a best effort basis. +Dynamic Kubelet Config (beta): This field should not be updated without a full node +reboot. It is safest to keep this value the same as the local config. +Default: ""
    cgroupsPerQOS
    +bool +
    Enable QoS based Cgroup hierarchy: top level cgroups for QoS Classes +And all Burstable and BestEffort pods are brought up under their +specific top level QoS cgroup. +Dynamic Kubelet Config (beta): This field should not be updated without a full node +reboot. It is safest to keep this value the same as the local config. +Default: true
    cgroupDriver
    +string +
    driver that the kubelet uses to manipulate cgroups on the host (cgroupfs or systemd) +Dynamic Kubelet Config (beta): This field should not be updated without a full node +reboot. It is safest to keep this value the same as the local config. +Default: "cgroupfs"
    cpuManagerPolicy
    +string +
    CPUManagerPolicy is the name of the policy to use. +Requires the CPUManager feature gate to be enabled. +Dynamic Kubelet Config (beta): This field should not be updated without a full node +reboot. It is safest to keep this value the same as the local config. +Default: "none"
    cpuManagerReconcilePeriod
    +meta/v1.Duration +
    CPU Manager reconciliation period. +Requires the CPUManager feature gate to be enabled. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +shortening the period may carry a performance impact. +Default: "10s"
    topologyManagerPolicy
    +string +
    TopologyManagerPolicy is the name of the policy to use. +Policies other than "none" require the TopologyManager feature gate to be enabled. +Dynamic Kubelet Config (beta): This field should not be updated without a full node +reboot. It is safest to keep this value the same as the local config. +Default: "none"
    topologyManagerScope
    +string +
    TopologyManagerScope represents the scope of topology hint generation +that topology manager requests and hint providers generate. +"pod" scope requires the TopologyManager feature gate to be enabled. +Default: "container"
    qosReserved
    +map[string]string +
    qosReserved is a set of resource name to percentage pairs that specify +the minimum percentage of a resource reserved for exclusive use by the +guaranteed QoS tier. +Currently supported resources: "memory" +Requires the QOSReserved feature gate to be enabled. +Dynamic Kubelet Config (beta): This field should not be updated without a full node +reboot. It is safest to keep this value the same as the local config. +Default: nil
    runtimeRequestTimeout
    +meta/v1.Duration +
    runtimeRequestTimeout is the timeout for all runtime requests except long running +requests - pull, logs, exec and attach. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may disrupt components that interact with the Kubelet server. +Default: "2m"
    hairpinMode
    +string +
    hairpinMode specifies how the Kubelet should configure the container +bridge for hairpin packets. +Setting this flag allows endpoints in a Service to loadbalance back to +themselves if they should try to access their own Service. Values: + "promiscuous-bridge": make the container bridge promiscuous. + "hairpin-veth": set the hairpin flag on container veth interfaces. + "none": do nothing. +Generally, one must set --hairpin-mode=hairpin-veth to achieve hairpin NAT, +because promiscuous-bridge assumes the existence of a container bridge named cbr0. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may require a node reboot, depending on the network plugin. +Default: "promiscuous-bridge"
    maxPods
    +int32 +
    maxPods is the number of pods that can run on this Kubelet. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +changes may cause Pods to fail admission on Kubelet restart, and may change +the value reported in Node.Status.Capacity[v1.ResourcePods], thus affecting +future scheduling decisions. Increasing this value may also decrease performance, +as more Pods can be packed into a single node. +Default: 110
    podCIDR
    +string +
    The CIDR to use for pod IP addresses, only used in standalone mode. +In cluster mode, this is obtained from the master. +Dynamic Kubelet Config (beta): This field should always be set to the empty default. +It should only set for standalone Kubelets, which cannot use Dynamic Kubelet Config. +Default: ""
    podPidsLimit
    +int64 +
    PodPidsLimit is the maximum number of pids in any pod. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +lowering it may prevent container processes from forking after the change. +Default: -1
    resolvConf
    +string +
    ResolverConfig is the resolver configuration file used as the basis +for the container DNS resolution configuration. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +changes will only take effect on Pods created after the update. Draining +the node is recommended before changing this field. +Default: "/etc/resolv.conf"
    runOnce
    +bool +
    RunOnce causes the Kubelet to check the API server once for pods, +run those in addition to the pods specified by static pod files, and exit. +Default: false
    cpuCFSQuota
    +bool +
    cpuCFSQuota enables CPU CFS quota enforcement for containers that +specify CPU limits. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +disabling it may reduce node stability. +Default: true
    cpuCFSQuotaPeriod
    +meta/v1.Duration +
    CPUCFSQuotaPeriod is the CPU CFS quota period value, cpu.cfs_period_us. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +limits set for containers will result in different cpu.cfs_quota settings. This +will trigger container restarts on the node being reconfigured. +Default: "100ms"
    nodeStatusMaxImages
    +int32 +
    nodeStatusMaxImages caps the number of images reported in Node.Status.Images. +Note: If -1 is specified, no cap will be applied. If 0 is specified, no image is returned. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +different values can be reported on node status. +Default: 50
    maxOpenFiles
    +int64 +
    maxOpenFiles is Number of files that can be opened by Kubelet process. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may impact the ability of the Kubelet to interact with the node's filesystem. +Default: 1000000
    contentType
    +string +
    contentType is contentType of requests sent to apiserver. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may impact the ability for the Kubelet to communicate with the API server. +If the Kubelet loses contact with the API server due to a change to this field, +the change cannot be reverted via dynamic Kubelet config. +Default: "application/vnd.kubernetes.protobuf"
    kubeAPIQPS
    +int32 +
    kubeAPIQPS is the QPS to use while talking with kubernetes apiserver +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may impact scalability by changing the amount of traffic the Kubelet +sends to the API server. +Default: 5
    kubeAPIBurst
    +int32 +
    kubeAPIBurst is the burst to allow while talking with kubernetes apiserver +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may impact scalability by changing the amount of traffic the Kubelet +sends to the API server. +Default: 10
    serializeImagePulls
    +bool +
    serializeImagePulls when enabled, tells the Kubelet to pull images one +at a time. We recommend ∗not∗ changing the default value on nodes that +run docker daemon with version < 1.9 or an Aufs storage backend. +Issue #10959 has more details. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may impact the performance of image pulls. +Default: true
    evictionHard
    +map[string]string +
    Map of signal names to quantities that defines hard eviction thresholds. For example: {"memory.available": "300Mi"}. +To explicitly disable, pass a 0% or 100% threshold on an arbitrary resource. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may trigger or delay Pod evictions. +Default: + memory.available: "100Mi" + nodefs.available: "10%" + nodefs.inodesFree: "5%" + imagefs.available: "15%"
    evictionSoft
    +map[string]string +
    Map of signal names to quantities that defines soft eviction thresholds. +For example: {"memory.available": "300Mi"}. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may trigger or delay Pod evictions, and may change the allocatable reported +by the node. +Default: nil
    evictionSoftGracePeriod
    +map[string]string +
    Map of signal names to quantities that defines grace periods for each soft eviction signal. +For example: {"memory.available": "30s"}. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may trigger or delay Pod evictions. +Default: nil
    evictionPressureTransitionPeriod
    +meta/v1.Duration +
    Duration for which the kubelet has to wait before transitioning out of an eviction pressure condition. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +lowering it may decrease the stability of the node when the node is overcommitted. +Default: "5m"
    evictionMaxPodGracePeriod
    +int32 +
    Maximum allowed grace period (in seconds) to use when terminating pods in +response to a soft eviction threshold being met. This value effectively caps +the Pod's TerminationGracePeriodSeconds value during soft evictions. +Note: Due to issue #64530, the behavior has a bug where this value currently just +overrides the grace period during soft eviction, which can increase the grace +period from what is set on the Pod. This bug will be fixed in a future release. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +lowering it decreases the amount of time Pods will have to gracefully clean +up before being killed during a soft eviction. +Default: 0
    evictionMinimumReclaim
    +map[string]string +
    Map of signal names to quantities that defines minimum reclaims, which describe the minimum +amount of a given resource the kubelet will reclaim when performing a pod eviction while +that resource is under pressure. For example: {"imagefs.available": "2Gi"} +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may change how well eviction can manage resource pressure. +Default: nil
    podsPerCore
    +int32 +
    podsPerCore is the maximum number of pods per core. Cannot exceed MaxPods. +If 0, this field is ignored. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +changes may cause Pods to fail admission on Kubelet restart, and may change +the value reported in Node.Status.Capacity[v1.ResourcePods], thus affecting +future scheduling decisions. Increasing this value may also decrease performance, +as more Pods can be packed into a single node. +Default: 0
    enableControllerAttachDetach
    +bool +
    enableControllerAttachDetach enables the Attach/Detach controller to +manage attachment/detachment of volumes scheduled to this node, and +disables kubelet from executing any attach/detach operations +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +changing which component is responsible for volume management on a live node +may result in volumes refusing to detach if the node is not drained prior to +the update, and if Pods are scheduled to the node before the +volumes.kubernetes.io/controller-managed-attach-detach annotation is updated by the +Kubelet. In general, it is safest to leave this value set the same as local config. +Default: true
    protectKernelDefaults
    +bool +
    protectKernelDefaults, if true, causes the Kubelet to error if kernel +flags are not as it expects. Otherwise the Kubelet will attempt to modify +kernel flags to match its expectation. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +enabling it may cause the Kubelet to crash-loop if the Kernel is not configured as +Kubelet expects. +Default: false
    makeIPTablesUtilChains
    +bool +
    If true, Kubelet ensures a set of iptables rules are present on host. +These rules will serve as utility rules for various components, e.g. KubeProxy. +The rules will be created based on IPTablesMasqueradeBit and IPTablesDropBit. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +disabling it will prevent the Kubelet from healing locally misconfigured iptables rules. +Default: true
    iptablesMasqueradeBit
    +int32 +
    iptablesMasqueradeBit is the bit of the iptables fwmark space to mark for SNAT +Values must be within the range [0, 31]. Must be different from other mark bits. +Warning: Please match the value of the corresponding parameter in kube-proxy. +TODO: clean up IPTablesMasqueradeBit in kube-proxy +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it needs to be coordinated with other components, like kube-proxy, and the update +will only be effective if MakeIPTablesUtilChains is enabled. +Default: 14
    iptablesDropBit
    +int32 +
    iptablesDropBit is the bit of the iptables fwmark space to mark for dropping packets. +Values must be within the range [0, 31]. Must be different from other mark bits. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it needs to be coordinated with other components, like kube-proxy, and the update +will only be effective if MakeIPTablesUtilChains is enabled. +Default: 15
    featureGates
    +map[string]bool +
    featureGates is a map of feature names to bools that enable or disable alpha/experimental +features. This field modifies piecemeal the built-in default values from +"k8s.io/kubernetes/pkg/features/kube_features.go". +Dynamic Kubelet Config (beta): If dynamically updating this field, consider the +documentation for the features you are enabling or disabling. While we +encourage feature developers to make it possible to dynamically enable +and disable features, some changes may require node reboots, and some +features may require careful coordination to retroactively disable. +Default: nil
    failSwapOn
    +bool +
    failSwapOn tells the Kubelet to fail to start if swap is enabled on the node. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +setting it to true will cause the Kubelet to crash-loop if swap is enabled. +Default: true
    containerLogMaxSize
    +string +
    A quantity defines the maximum size of the container log file before it is rotated. +For example: "5Mi" or "256Ki". +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may trigger log rotation. +Default: "10Mi"
    containerLogMaxFiles
    +int32 +
    Maximum number of container log files that can be present for a container. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +lowering it may cause log files to be deleted. +Default: 5
    configMapAndSecretChangeDetectionStrategy
    +ResourceChangeDetectionStrategy +
    ConfigMapAndSecretChangeDetectionStrategy is a mode in which +config map and secret managers are running. +Default: "Watch"
    systemReserved
    +map[string]string +
    systemReserved is a set of ResourceName=ResourceQuantity (e.g. cpu=200m,memory=150G) +pairs that describe resources reserved for non-kubernetes components. +Currently only cpu and memory are supported. +See http://kubernetes.io/docs/user-guide/compute-resources for more detail. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may not be possible to increase the reserved resources, because this +requires resizing cgroups. Always look for a NodeAllocatableEnforced event +after updating this field to ensure that the update was successful. +Default: nil
    kubeReserved
    +map[string]string +
    A set of ResourceName=ResourceQuantity (e.g. cpu=200m,memory=150G) pairs +that describe resources reserved for kubernetes system components. +Currently cpu, memory and local storage for root file system are supported. +See http://kubernetes.io/docs/user-guide/compute-resources for more detail. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may not be possible to increase the reserved resources, because this +requires resizing cgroups. Always look for a NodeAllocatableEnforced event +after updating this field to ensure that the update was successful. +Default: nil
    reservedSystemCPUs*
    +string +
    This ReservedSystemCPUs option specifies the cpu list reserved for the host level system threads and kubernetes related threads. +This provide a "static" CPU list rather than the "dynamic" list by system-reserved and kube-reserved. +This option overwrites CPUs provided by system-reserved and kube-reserved.
    showHiddenMetricsForVersion
    +string +
    The previous version for which you want to show hidden metrics. +Only the previous minor version is meaningful, other values will not be allowed. +The format is ., e.g.: '1.16'. +The purpose of this format is make sure you have the opportunity to notice if the next release hides additional metrics, +rather than being surprised when they are permanently removed in the release after that. +Default: ""
    systemReservedCgroup
    +string +
    This flag helps kubelet identify absolute name of top level cgroup used to enforce `SystemReserved` compute resource reservation for OS system daemons. +Refer to [Node Allocatable](https://git.k8s.io/community/contributors/design-proposals/node/node-allocatable.md) doc for more information. +Dynamic Kubelet Config (beta): This field should not be updated without a full node +reboot. It is safest to keep this value the same as the local config. +Default: ""
    kubeReservedCgroup
    +string +
    This flag helps kubelet identify absolute name of top level cgroup used to enforce `KubeReserved` compute resource reservation for Kubernetes node system daemons. +Refer to [Node Allocatable](https://git.k8s.io/community/contributors/design-proposals/node/node-allocatable.md) doc for more information. +Dynamic Kubelet Config (beta): This field should not be updated without a full node +reboot. It is safest to keep this value the same as the local config. +Default: ""
    enforceNodeAllocatable
    +[]string +
    This flag specifies the various Node Allocatable enforcements that Kubelet needs to perform. +This flag accepts a list of options. Acceptable options are `none`, `pods`, `system-reserved` & `kube-reserved`. +If `none` is specified, no other options may be specified. +Refer to [Node Allocatable](https://git.k8s.io/community/contributors/design-proposals/node/node-allocatable.md) doc for more information. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +removing enforcements may reduce the stability of the node. Alternatively, adding +enforcements may reduce the stability of components which were using more than +the reserved amount of resources; for example, enforcing kube-reserved may cause +Kubelets to OOM if it uses more than the reserved resources, and enforcing system-reserved +may cause system daemons to OOM if they use more than the reserved resources. +Default: ["pods"]
    allowedUnsafeSysctls
    +[]string +
    A comma separated whitelist of unsafe sysctls or sysctl patterns (ending in ∗). +Unsafe sysctl groups are kernel.shm∗, kernel.msg∗, kernel.sem, fs.mqueue.∗, and net.∗. +These sysctls are namespaced but not allowed by default. For example: "kernel.msg∗,net.ipv4.route.min_pmtu" +Default: []
    volumePluginDir
    +string +
    volumePluginDir is the full path of the directory in which to search +for additional third party volume plugins. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that changing +the volumePluginDir may disrupt workloads relying on third party volume plugins. +Default: "/usr/libexec/kubernetes/kubelet-plugins/volume/exec/"
    providerID
    +string +
    providerID, if set, sets the unique id of the instance that an external provider (i.e. cloudprovider) +can use to identify a specific node. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may impact the ability of the Kubelet to interact with cloud providers. +Default: ""
    kernelMemcgNotification
    +bool +
    kernelMemcgNotification, if set, the kubelet will integrate with the kernel memcg notification +to determine if memory eviction thresholds are crossed rather than polling. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may impact the way Kubelet interacts with the kernel. +Default: false
    logging*
    +LoggingConfiguration +
    Logging specifies the options of logging. +Refer [Logs Options](https://github.com/kubernetes/component-base/blob/master/logs/options.go) for more information. +Defaults: + Format: text
    enableSystemLogHandler
    +bool +
    enableSystemLogHandler enables system logs via web interface host:port/logs/ +Default: true
    shutdownGracePeriod
    +meta/v1.Duration +
    ShutdownGracePeriod specifies the total duration that the node should delay the shutdown and total grace period for pod termination during a node shutdown. +Default: "30s"
    shutdownGracePeriodCriticalPods
    +meta/v1.Duration +
    ShutdownGracePeriodCriticalPods specifies the duration used to terminate critical pods during a node shutdown. This should be less than ShutdownGracePeriod. +For example, if ShutdownGracePeriod=30s, and ShutdownGracePeriodCriticalPods=10s, during a node shutdown the first 20 seconds would be reserved for gracefully terminating normal pods, and the last 10 seconds would be reserved for terminating critical pods. +Default: "10s"
    + + + +### `SerializedNodeConfigSource` {#kubelet-config-k8s-io-v1beta1-SerializedNodeConfigSource} + + + + + +SerializedNodeConfigSource allows us to serialize v1.NodeConfigSource. +This type is used internally by the Kubelet for tracking checkpointed dynamic configs. +It exists in the kubeletconfig API group because it is classified as a versioned input to the Kubelet. + + + + + + + + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    kubelet.config.k8s.io/v1beta1
    kind
    string
    SerializedNodeConfigSource
    source
    +core/v1.NodeConfigSource +
    Source is the source that we are serializing
    + + + +### `HairpinMode` {#kubelet-config-k8s-io-v1beta1-HairpinMode} + +(Alias of `string`) + + + +HairpinMode denotes how the kubelet should configure networking to handle +hairpin packets. + + + + + +### `KubeletAnonymousAuthentication` {#kubelet-config-k8s-io-v1beta1-KubeletAnonymousAuthentication} + + + + +**Appears in:** + +- [KubeletAuthentication](#kubelet-config-k8s-io-v1beta1-KubeletAuthentication) + + + + + + + + + + + + + + + + +
    FieldDescription
    enabled
    +bool +
    enabled allows anonymous requests to the kubelet server. +Requests that are not rejected by another authentication method are treated as anonymous requests. +Anonymous requests have a username of system:anonymous, and a group name of system:unauthenticated.
    + + + +### `KubeletAuthentication` {#kubelet-config-k8s-io-v1beta1-KubeletAuthentication} + + + + +**Appears in:** + +- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration) + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    x509
    +KubeletX509Authentication +
    x509 contains settings related to x509 client certificate authentication
    webhook
    +KubeletWebhookAuthentication +
    webhook contains settings related to webhook bearer token authentication
    anonymous
    +KubeletAnonymousAuthentication +
    anonymous contains settings related to anonymous authentication
    + + + +### `KubeletAuthorization` {#kubelet-config-k8s-io-v1beta1-KubeletAuthorization} + + + + +**Appears in:** + +- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration) + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    mode
    +KubeletAuthorizationMode +
    mode is the authorization mode to apply to requests to the kubelet server. +Valid values are AlwaysAllow and Webhook. +Webhook mode uses the SubjectAccessReview API to determine authorization.
    webhook
    +KubeletWebhookAuthorization +
    webhook contains settings related to Webhook authorization.
    + + + +### `KubeletAuthorizationMode` {#kubelet-config-k8s-io-v1beta1-KubeletAuthorizationMode} + +(Alias of `string`) + + +**Appears in:** + +- [KubeletAuthorization](#kubelet-config-k8s-io-v1beta1-KubeletAuthorization) + + + + + + + + +### `KubeletWebhookAuthentication` {#kubelet-config-k8s-io-v1beta1-KubeletWebhookAuthentication} + + + + +**Appears in:** + +- [KubeletAuthentication](#kubelet-config-k8s-io-v1beta1-KubeletAuthentication) + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    enabled
    +bool +
    enabled allows bearer token authentication backed by the tokenreviews.authentication.k8s.io API
    cacheTTL
    +meta/v1.Duration +
    cacheTTL enables caching of authentication results
    + + + +### `KubeletWebhookAuthorization` {#kubelet-config-k8s-io-v1beta1-KubeletWebhookAuthorization} + + + + +**Appears in:** + +- [KubeletAuthorization](#kubelet-config-k8s-io-v1beta1-KubeletAuthorization) + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    cacheAuthorizedTTL
    +meta/v1.Duration +
    cacheAuthorizedTTL is the duration to cache 'authorized' responses from the webhook authorizer.
    cacheUnauthorizedTTL
    +meta/v1.Duration +
    cacheUnauthorizedTTL is the duration to cache 'unauthorized' responses from the webhook authorizer.
    + + + +### `KubeletX509Authentication` {#kubelet-config-k8s-io-v1beta1-KubeletX509Authentication} + + + + +**Appears in:** + +- [KubeletAuthentication](#kubelet-config-k8s-io-v1beta1-KubeletAuthentication) + + + + + + + + + + + + + + + + +
    FieldDescription
    clientCAFile
    +string +
    clientCAFile is the path to a PEM-encoded certificate bundle. If set, any request presenting a client certificate +signed by one of the authorities in the bundle is authenticated with a username corresponding to the CommonName, +and groups corresponding to the Organization in the client certificate.
    + + + +### `ResourceChangeDetectionStrategy` {#kubelet-config-k8s-io-v1beta1-ResourceChangeDetectionStrategy} + +(Alias of `string`) + + +**Appears in:** + +- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration) + + +ResourceChangeDetectionStrategy denotes a mode in which internal +managers (secret, configmap) are discovering object changes. + + + + + + + +### `LoggingConfiguration` {#LoggingConfiguration} + + + + +**Appears in:** + +- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration) + + +LoggingConfiguration contains logging options +Refer [Logs Options](https://github.com/kubernetes/component-base/blob/master/logs/options.go) for more information. + + + + + + + + + + + + + + + + + + +
    FieldDescription
    format*
    +string +
    Format Flag specifies the structure of log messages. +default value of format is `text`
    sanitization*
    +bool +
    [Experimental] When enabled prevents logging of fields tagged as sensitive (passwords, keys, tokens). +Runtime log sanitization may introduce significant computation overhead and therefore should not be enabled in production.`)
    diff --git a/content/en/docs/reference/command-line-tools-reference/kubelet-tls-bootstrapping.md b/content/en/docs/reference/command-line-tools-reference/kubelet-tls-bootstrapping.md index a441f8ce5b..1b1142913f 100644 --- a/content/en/docs/reference/command-line-tools-reference/kubelet-tls-bootstrapping.md +++ b/content/en/docs/reference/command-line-tools-reference/kubelet-tls-bootstrapping.md @@ -24,11 +24,10 @@ found [here](https://github.com/kubernetes/kubernetes/pull/20439). This document describes the process of node initialization, how to set up TLS client certificate bootstrapping for kubelets, and how it works. - - ## Initialization Process + When a worker node starts up, the kubelet does the following: 1. Look for its `kubeconfig` file @@ -54,6 +53,7 @@ The TLS Bootstrapping described in this document is intended to simplify, and pa a cluster. ### Bootstrap Initialization + In the bootstrap initialization process, the following occurs: 1. kubelet begins @@ -77,6 +77,7 @@ In the bootstrap initialization process, the following occurs: The rest of this document describes the necessary steps to configure TLS Bootstrapping, and its limitations. ## Configuration + To configure for TLS bootstrapping and optional automatic approval, you must configure options on the following components: * kube-apiserver @@ -87,6 +88,7 @@ To configure for TLS bootstrapping and optional automatic approval, you must con In addition, you need your Kubernetes Certificate Authority (CA). ## Certificate Authority + As without bootstrapping, you will need a Certificate Authority (CA) key and certificate. As without bootstrapping, these will be used to sign the kubelet certificate. As before, it is your responsibility to distribute them to master nodes. @@ -96,6 +98,7 @@ We will refer to these as "Kubernetes CA certificate and key". All Kubernetes components that use these certificates - kubelet, kube-apiserver, kube-controller-manager - assume the key and certificate to be PEM-encoded. ## kube-apiserver configuration + The kube-apiserver has several requirements to enable TLS bootstrapping: * Recognizing CA that signs the client certificate @@ -103,6 +106,7 @@ The kube-apiserver has several requirements to enable TLS bootstrapping: * Authorize the bootstrapping kubelet to create a certificate signing request (CSR) ### Recognizing client certificates + This is normal for all client certificate authentication. If not already set, add the `--client-ca-file=FILENAME` flag to the kube-apiserver command to enable client certificate authentication, referencing a certificate authority bundle @@ -110,6 +114,7 @@ containing the signing certificate, for example `--client-ca-file=/var/lib/kubernetes/ca.pem`. ### Initial bootstrap authentication + In order for the bootstrapping kubelet to connect to kube-apiserver and request a certificate, it must first authenticate to the server. You can use any [authenticator](/docs/reference/access-authn-authz/authentication/) that can authenticate the kubelet. @@ -132,13 +137,13 @@ A kubelet authenticating using bootstrap tokens is authenticated as a user in th As this feature matures, you should ensure tokens are bound to a Role Based Access Control (RBAC) policy -which limits requests (using the [bootstrap -token](/docs/reference/access-authn-authz/bootstrap-tokens/)) strictly to client +which limits requests (using the [bootstrap token](/docs/reference/access-authn-authz/bootstrap-tokens/)) strictly to client requests related to certificate provisioning. With RBAC in place, scoping the tokens to a group allows for great flexibility. For example, you could disable a particular bootstrap group's access when you are done provisioning the nodes. #### Bootstrap tokens + Bootstrap tokens are described in detail [here](/docs/reference/access-authn-authz/bootstrap-tokens/). These are tokens that are stored as secrets in the Kubernetes cluster, and then issued to the individual kubelet. You can use a single token for an entire cluster, or issue one per worker node. @@ -148,7 +153,7 @@ The process is two-fold: 2. Issue the token to the kubelet From the kubelet's perspective, one token is like another and has no special meaning. -From the kube-apiserver's perspective, however, the bootstrap token is special. Due to its `Type`, `namespace` and `name`, kube-apiserver recognizes it as a special token, +From the kube-apiserver's perspective, however, the bootstrap token is special. Due to its `type`, `namespace` and `name`, kube-apiserver recognizes it as a special token, and grants anyone authenticating with that token special bootstrap rights, notably treating them as a member of the `system:bootstrappers` group. This fulfills a basic requirement for TLS bootstrapping. @@ -156,17 +161,18 @@ The details for creating the secret are available [here](/docs/reference/access- If you want to use bootstrap tokens, you must enable it on kube-apiserver with the flag: -``` +```console --enable-bootstrap-token-auth=true ``` #### Token authentication file + kube-apiserver has an ability to accept tokens as authentication. These tokens are arbitrary but should represent at least 128 bits of entropy derived from a secure random number generator (such as `/dev/urandom` on most modern Linux systems). There are multiple ways you can generate a token. For example: -``` +```shell head -c 16 /dev/urandom | od -An -t x | tr -d ' ' ``` @@ -175,7 +181,7 @@ will generate tokens that look like `02b50b05283e98dd0fd71db496ef01e8`. The token file should look like the following example, where the first three values can be anything and the quoted group name should be as depicted: -``` +```console 02b50b05283e98dd0fd71db496ef01e8,kubelet-bootstrap,10001,"system:bootstrappers" ``` @@ -185,11 +191,16 @@ systemd unit file perhaps) to enable the token file. See docs further details. ### Authorize kubelet to create CSR -Now that the bootstrapping node is _authenticated_ as part of the `system:bootstrappers` group, it needs to be _authorized_ to create a certificate signing request (CSR) as well as retrieve it when done. Fortunately, Kubernetes ships with a `ClusterRole` with precisely these (and only these) permissions, `system:node-bootstrapper`. + +Now that the bootstrapping node is _authenticated_ as part of the +`system:bootstrappers` group, it needs to be _authorized_ to create a +certificate signing request (CSR) as well as retrieve it when done. +Fortunately, Kubernetes ships with a `ClusterRole` with precisely these (and +only these) permissions, `system:node-bootstrapper`. To do this, you only need to create a `ClusterRoleBinding` that binds the `system:bootstrappers` group to the cluster role `system:node-bootstrapper`. -``` +```yaml # enable bootstrapping nodes to create CSR apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRoleBinding @@ -206,6 +217,7 @@ roleRef: ``` ## kube-controller-manager configuration + While the apiserver receives the requests for certificates from the kubelet and authenticates those requests, the controller-manager is responsible for issuing actual signed certificates. @@ -221,6 +233,7 @@ In order for the controller-manager to sign certificates, it needs the following * enabling CSR signing ### Access to key and certificate + As described earlier, you need to create a Kubernetes CA key and certificate, and distribute it to the master nodes. These will be used by the controller-manager to sign the kubelet certificates. @@ -230,23 +243,24 @@ with the flag `--client-ca-file=FILENAME` (for example, `--client-ca-file=/var/l To provide the Kubernetes CA key and certificate to kube-controller-manager, use the following flags: -``` +```shell --cluster-signing-cert-file="/etc/path/to/kubernetes/ca/ca.crt" --cluster-signing-key-file="/etc/path/to/kubernetes/ca/ca.key" ``` for example: -``` +```shell --cluster-signing-cert-file="/var/lib/kubernetes/ca.pem" --cluster-signing-key-file="/var/lib/kubernetes/ca-key.pem" ``` The validity duration of signed certificates can be configured with flag: -``` +```shell --cluster-signing-duration ``` ### Approval + In order to approve CSRs, you need to tell the controller-manager that it is acceptable to approve them. This is done by granting RBAC permissions to the correct group. @@ -257,7 +271,7 @@ There are two distinct sets of permissions: To enable the kubelet to request and receive a new certificate, create a `ClusterRoleBinding` that binds the group in which the bootstrapping node is a member `system:bootstrappers` to the `ClusterRole` that grants it permission, `system:certificates.k8s.io:certificatesigningrequests:nodeclient`: -```yml +```yaml # Approve all CSRs for the group "system:bootstrappers" apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRoleBinding @@ -276,7 +290,7 @@ roleRef: To enable the kubelet to renew its own client certificate, create a `ClusterRoleBinding` that binds the group in which the fully functioning node is a member `system:nodes` to the `ClusterRole` that grants it permission, `system:certificates.k8s.io:certificatesigningrequests:selfnodeclient`: -```yml +```yaml # Approve renewal CSRs for the group "system:nodes" apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRoleBinding @@ -294,8 +308,8 @@ roleRef: The `csrapproving` controller that ships as part of [kube-controller-manager](/docs/admin/kube-controller-manager/) and is enabled -by default. The controller uses the [`SubjectAccessReview` -API](/docs/reference/access-authn-authz/authorization/#checking-api-access) to +by default. The controller uses the +[`SubjectAccessReview` API](/docs/reference/access-authn-authz/authorization/#checking-api-access) to determine if a given user is authorized to request a CSR, then approves based on the authorization outcome. To prevent conflicts with other approvers, the builtin approver doesn't explicitly deny CSRs. It only ignores unauthorized @@ -304,6 +318,7 @@ collection. ## kubelet configuration + Finally, with the master nodes properly set up and all of the necessary authentication and authorization in place, we can configure the kubelet. The kubelet requires the following configuration to bootstrap: @@ -317,7 +332,7 @@ The bootstrap `kubeconfig` should be in a path available to the kubelet, for exa Its format is identical to a normal `kubeconfig` file. A sample file might look as follows: -```yml +```yaml apiVersion: v1 kind: Config clusters: @@ -371,6 +386,7 @@ specified by `--kubeconfig`. The certificate and key file will be placed in the directory specified by `--cert-dir`. ### Client and Serving Certificates + All of the above relate to kubelet _client_ certificates, specifically, the certificates a kubelet uses to authenticate to kube-apiserver. @@ -387,6 +403,7 @@ be used as serving certificates, or `server auth`. However, you _can_ enable its server certificate, at least partially, via certificate rotation. ### Certificate Rotation + Kubernetes v1.8 and higher kubelet implements __beta__ features for enabling rotation of its client and/or serving certificates. These can be enabled through the respective `RotateKubeletClientCertificate` and @@ -429,6 +446,7 @@ A deployment-specific approval process for kubelet serving certificates should t {{< /note >}} ## Other authenticating components + All of TLS bootstrapping described in this document relates to the kubelet. However, other components may need to communicate directly with kube-apiserver. Notable is kube-proxy, which is part of the Kubernetes control plane and runs on every node, but may also include other components such as monitoring or networking. diff --git a/content/en/docs/reference/config-api/kubelet-config.v1beta1.md b/content/en/docs/reference/config-api/kubelet-config.v1beta1.md new file mode 100644 index 0000000000..bee05b68db --- /dev/null +++ b/content/en/docs/reference/config-api/kubelet-config.v1beta1.md @@ -0,0 +1,1604 @@ +--- +title: Kubelet Configuration (v1beta1) +content_type: tool-reference +package: kubelet.config.k8s.io/v1beta1 +auto_generated: true +--- + + +## Resource Types + + +- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration) +- [SerializedNodeConfigSource](#kubelet-config-k8s-io-v1beta1-SerializedNodeConfigSource) + + + + +## `KubeletConfiguration` {#kubelet-config-k8s-io-v1beta1-KubeletConfiguration} + + + + + +KubeletConfiguration contains the configuration for the Kubelet + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    kubelet.config.k8s.io/v1beta1
    kind
    string
    KubeletConfiguration
    enableServer [Required]
    +bool +
    + enableServer enables Kubelet's secured server. +Note: Kubelet's insecure port is controlled by the readOnlyPort option. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may disrupt components that interact with the Kubelet server. +Default: true
    staticPodPath
    +string +
    + staticPodPath is the path to the directory containing local (static) pods to +run, or the path to a single static pod file. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +the set of static pods specified at the new path may be different than the +ones the Kubelet initially started with, and this may disrupt your node. +Default: ""
    syncFrequency
    +meta/v1.Duration +
    + syncFrequency is the max period between synchronizing running +containers and config. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +shortening this duration may have a negative performance impact, especially +as the number of Pods on the node increases. Alternatively, increasing this +duration will result in longer refresh times for ConfigMaps and Secrets. +Default: "1m"
    fileCheckFrequency
    +meta/v1.Duration +
    + fileCheckFrequency is the duration between checking config files for +new data +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +shortening the duration will cause the Kubelet to reload local Static Pod +configurations more frequently, which may have a negative performance impact. +Default: "20s"
    httpCheckFrequency
    +meta/v1.Duration +
    + httpCheckFrequency is the duration between checking http for new data +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +shortening the duration will cause the Kubelet to poll staticPodURL more +frequently, which may have a negative performance impact. +Default: "20s"
    staticPodURL
    +string +
    + staticPodURL is the URL for accessing static pods to run +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +the set of static pods specified at the new URL may be different than the +ones the Kubelet initially started with, and this may disrupt your node. +Default: ""
    staticPodURLHeader
    +map[string][]string +
    + staticPodURLHeader is a map of slices with HTTP headers to use when accessing the podURL +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may disrupt the ability to read the latest set of static pods from StaticPodURL. +Default: nil
    address
    +string +
    + address is the IP address for the Kubelet to serve on (set to 0.0.0.0 +for all interfaces). +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may disrupt components that interact with the Kubelet server. +Default: "0.0.0.0"
    port
    +int32 +
    + port is the port for the Kubelet to serve on. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may disrupt components that interact with the Kubelet server. +Default: 10250
    readOnlyPort
    +int32 +
    + readOnlyPort is the read-only port for the Kubelet to serve on with +no authentication/authorization. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may disrupt components that interact with the Kubelet server. +Default: 0 (disabled)
    tlsCertFile
    +string +
    + tlsCertFile is the file containing x509 Certificate for HTTPS. (CA cert, +if any, concatenated after server cert). If tlsCertFile and +tlsPrivateKeyFile are not provided, a self-signed certificate +and key are generated for the public address and saved to the directory +passed to the Kubelet's --cert-dir flag. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may disrupt components that interact with the Kubelet server. +Default: ""
    tlsPrivateKeyFile
    +string +
    + tlsPrivateKeyFile is the file containing x509 private key matching tlsCertFile +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may disrupt components that interact with the Kubelet server. +Default: ""
    tlsCipherSuites
    +[]string +
    + TLSCipherSuites is the list of allowed cipher suites for the server. +Values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may disrupt components that interact with the Kubelet server. +Default: nil
    tlsMinVersion
    +string +
    + TLSMinVersion is the minimum TLS version supported. +Values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may disrupt components that interact with the Kubelet server. +Default: ""
    rotateCertificates
    +bool +
    + rotateCertificates enables client certificate rotation. The Kubelet will request a +new certificate from the certificates.k8s.io API. This requires an approver to approve the +certificate signing requests. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +disabling it may disrupt the Kubelet's ability to authenticate with the API server +after the current certificate expires. +Default: false
    serverTLSBootstrap
    +bool +
    + serverTLSBootstrap enables server certificate bootstrap. Instead of self +signing a serving certificate, the Kubelet will request a certificate from +the certificates.k8s.io API. This requires an approver to approve the +certificate signing requests. The RotateKubeletServerCertificate feature +must be enabled. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +disabling it will stop the renewal of Kubelet server certificates, which can +disrupt components that interact with the Kubelet server in the long term, +due to certificate expiration. +Default: false
    authentication
    +KubeletAuthentication +
    + authentication specifies how requests to the Kubelet's server are authenticated +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may disrupt components that interact with the Kubelet server. +Defaults: + anonymous: + enabled: false + webhook: + enabled: true + cacheTTL: "2m"
    authorization
    +KubeletAuthorization +
    + authorization specifies how requests to the Kubelet's server are authorized +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may disrupt components that interact with the Kubelet server. +Defaults: + mode: Webhook + webhook: + cacheAuthorizedTTL: "5m" + cacheUnauthorizedTTL: "30s"
    registryPullQPS
    +int32 +
    + registryPullQPS is the limit of registry pulls per second. +Set to 0 for no limit. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may impact scalability by changing the amount of traffic produced +by image pulls. +Default: 5
    registryBurst
    +int32 +
    + registryBurst is the maximum size of bursty pulls, temporarily allows +pulls to burst to this number, while still not exceeding registryPullQPS. +Only used if registryPullQPS > 0. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may impact scalability by changing the amount of traffic produced +by image pulls. +Default: 10
    eventRecordQPS
    +int32 +
    + eventRecordQPS is the maximum event creations per second. If 0, there +is no limit enforced. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may impact scalability by changing the amount of traffic produced by +event creations. +Default: 5
    eventBurst
    +int32 +
    + eventBurst is the maximum size of a burst of event creations, temporarily +allows event creations to burst to this number, while still not exceeding +eventRecordQPS. Only used if eventRecordQPS > 0. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may impact scalability by changing the amount of traffic produced by +event creations. +Default: 10
    enableDebuggingHandlers
    +bool +
    + enableDebuggingHandlers enables server endpoints for log access +and local running of containers and commands, including the exec, +attach, logs, and portforward features. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +disabling it may disrupt components that interact with the Kubelet server. +Default: true
    enableContentionProfiling
    +bool +
    + enableContentionProfiling enables lock contention profiling, if enableDebuggingHandlers is true. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +enabling it may carry a performance impact. +Default: false
    healthzPort
    +int32 +
    + healthzPort is the port of the localhost healthz endpoint (set to 0 to disable) +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may disrupt components that monitor Kubelet health. +Default: 10248
    healthzBindAddress
    +string +
    + healthzBindAddress is the IP address for the healthz server to serve on +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may disrupt components that monitor Kubelet health. +Default: "127.0.0.1"
    oomScoreAdj
    +int32 +
    + oomScoreAdj is The oom-score-adj value for kubelet process. Values +must be within the range [-1000, 1000]. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may impact the stability of nodes under memory pressure. +Default: -999
    clusterDomain
    +string +
    + clusterDomain is the DNS domain for this cluster. If set, kubelet will +configure all containers to search this domain in addition to the +host's search domains. +Dynamic Kubelet Config (beta): Dynamically updating this field is not recommended, +as it should be kept in sync with the rest of the cluster. +Default: ""
    clusterDNS
    +[]string +
    + clusterDNS is a list of IP addresses for the cluster DNS server. If set, +kubelet will configure all containers to use this for DNS resolution +instead of the host's DNS servers. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +changes will only take effect on Pods created after the update. Draining +the node is recommended before changing this field. +Default: nil
    streamingConnectionIdleTimeout
    +meta/v1.Duration +
    + streamingConnectionIdleTimeout is the maximum time a streaming connection +can be idle before the connection is automatically closed. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may impact components that rely on infrequent updates over streaming +connections to the Kubelet server. +Default: "4h"
    nodeStatusUpdateFrequency
    +meta/v1.Duration +
    + nodeStatusUpdateFrequency is the frequency that kubelet computes node +status. If node lease feature is not enabled, it is also the frequency that +kubelet posts node status to master. +Note: When node lease feature is not enabled, be cautious when changing the +constant, it must work with nodeMonitorGracePeriod in nodecontroller. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may impact node scalability, and also that the node controller's +nodeMonitorGracePeriod must be set to N∗NodeStatusUpdateFrequency, +where N is the number of retries before the node controller marks +the node unhealthy. +Default: "10s"
    nodeStatusReportFrequency
    +meta/v1.Duration +
    + nodeStatusReportFrequency is the frequency that kubelet posts node +status to master if node status does not change. Kubelet will ignore this +frequency and post node status immediately if any change is detected. It is +only used when node lease feature is enabled. nodeStatusReportFrequency's +default value is 1m. But if nodeStatusUpdateFrequency is set explicitly, +nodeStatusReportFrequency's default value will be set to +nodeStatusUpdateFrequency for backward compatibility. +Default: "1m"
    nodeLeaseDurationSeconds
    +int32 +
    + nodeLeaseDurationSeconds is the duration the Kubelet will set on its corresponding Lease, +when the NodeLease feature is enabled. This feature provides an indicator of node +health by having the Kubelet create and periodically renew a lease, named after the node, +in the kube-node-lease namespace. If the lease expires, the node can be considered unhealthy. +The lease is currently renewed every 10s, per KEP-0009. In the future, the lease renewal interval +may be set based on the lease duration. +Requires the NodeLease feature gate to be enabled. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +decreasing the duration may reduce tolerance for issues that temporarily prevent +the Kubelet from renewing the lease (e.g. a short-lived network issue). +Default: 40
    imageMinimumGCAge
    +meta/v1.Duration +
    + imageMinimumGCAge is the minimum age for an unused image before it is +garbage collected. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may trigger or delay garbage collection, and may change the image overhead +on the node. +Default: "2m"
    imageGCHighThresholdPercent
    +int32 +
    + imageGCHighThresholdPercent is the percent of disk usage after which +image garbage collection is always run. The percent is calculated as +this field value out of 100. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may trigger or delay garbage collection, and may change the image overhead +on the node. +Default: 85
    imageGCLowThresholdPercent
    +int32 +
    + imageGCLowThresholdPercent is the percent of disk usage before which +image garbage collection is never run. Lowest disk usage to garbage +collect to. The percent is calculated as this field value out of 100. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may trigger or delay garbage collection, and may change the image overhead +on the node. +Default: 80
    volumeStatsAggPeriod
    +meta/v1.Duration +
    + How frequently to calculate and cache volume disk usage for all pods +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +shortening the period may carry a performance impact. +Default: "1m"
    kubeletCgroups
    +string +
    + kubeletCgroups is the absolute name of cgroups to isolate the kubelet in +Dynamic Kubelet Config (beta): This field should not be updated without a full node +reboot. It is safest to keep this value the same as the local config. +Default: ""
    systemCgroups
    +string +
    + systemCgroups is absolute name of cgroups in which to place +all non-kernel processes that are not already in a container. Empty +for no container. Rolling back the flag requires a reboot. +Dynamic Kubelet Config (beta): This field should not be updated without a full node +reboot. It is safest to keep this value the same as the local config. +Default: ""
    cgroupRoot
    +string +
    + cgroupRoot is the root cgroup to use for pods. This is handled by the +container runtime on a best effort basis. +Dynamic Kubelet Config (beta): This field should not be updated without a full node +reboot. It is safest to keep this value the same as the local config. +Default: ""
    cgroupsPerQOS
    +bool +
    + Enable QoS based Cgroup hierarchy: top level cgroups for QoS Classes +And all Burstable and BestEffort pods are brought up under their +specific top level QoS cgroup. +Dynamic Kubelet Config (beta): This field should not be updated without a full node +reboot. It is safest to keep this value the same as the local config. +Default: true
    cgroupDriver
    +string +
    + driver that the kubelet uses to manipulate cgroups on the host (cgroupfs or systemd) +Dynamic Kubelet Config (beta): This field should not be updated without a full node +reboot. It is safest to keep this value the same as the local config. +Default: "cgroupfs"
    cpuManagerPolicy
    +string +
    + CPUManagerPolicy is the name of the policy to use. +Requires the CPUManager feature gate to be enabled. +Dynamic Kubelet Config (beta): This field should not be updated without a full node +reboot. It is safest to keep this value the same as the local config. +Default: "none"
    cpuManagerReconcilePeriod
    +meta/v1.Duration +
    + CPU Manager reconciliation period. +Requires the CPUManager feature gate to be enabled. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +shortening the period may carry a performance impact. +Default: "10s"
    topologyManagerPolicy
    +string +
    + TopologyManagerPolicy is the name of the policy to use. +Policies other than "none" require the TopologyManager feature gate to be enabled. +Dynamic Kubelet Config (beta): This field should not be updated without a full node +reboot. It is safest to keep this value the same as the local config. +Default: "none"
    topologyManagerScope
    +string +
    + TopologyManagerScope represents the scope of topology hint generation +that topology manager requests and hint providers generate. +"pod" scope requires the TopologyManager feature gate to be enabled. +Default: "container"
    qosReserved
    +map[string]string +
    + qosReserved is a set of resource name to percentage pairs that specify +the minimum percentage of a resource reserved for exclusive use by the +guaranteed QoS tier. +Currently supported resources: "memory" +Requires the QOSReserved feature gate to be enabled. +Dynamic Kubelet Config (beta): This field should not be updated without a full node +reboot. It is safest to keep this value the same as the local config. +Default: nil
    runtimeRequestTimeout
    +meta/v1.Duration +
    + runtimeRequestTimeout is the timeout for all runtime requests except long running +requests - pull, logs, exec and attach. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may disrupt components that interact with the Kubelet server. +Default: "2m"
    hairpinMode
    +string +
    + hairpinMode specifies how the Kubelet should configure the container +bridge for hairpin packets. +Setting this flag allows endpoints in a Service to loadbalance back to +themselves if they should try to access their own Service. Values: + "promiscuous-bridge": make the container bridge promiscuous. + "hairpin-veth": set the hairpin flag on container veth interfaces. + "none": do nothing. +Generally, one must set --hairpin-mode=hairpin-veth to achieve hairpin NAT, +because promiscuous-bridge assumes the existence of a container bridge named cbr0. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may require a node reboot, depending on the network plugin. +Default: "promiscuous-bridge"
    maxPods
    +int32 +
    + maxPods is the number of pods that can run on this Kubelet. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +changes may cause Pods to fail admission on Kubelet restart, and may change +the value reported in Node.Status.Capacity[v1.ResourcePods], thus affecting +future scheduling decisions. Increasing this value may also decrease performance, +as more Pods can be packed into a single node. +Default: 110
    podCIDR
    +string +
    + The CIDR to use for pod IP addresses, only used in standalone mode. +In cluster mode, this is obtained from the master. +Dynamic Kubelet Config (beta): This field should always be set to the empty default. +It should only set for standalone Kubelets, which cannot use Dynamic Kubelet Config. +Default: ""
    podPidsLimit
    +int64 +
    + PodPidsLimit is the maximum number of pids in any pod. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +lowering it may prevent container processes from forking after the change. +Default: -1
    resolvConf
    +string +
    + ResolverConfig is the resolver configuration file used as the basis +for the container DNS resolution configuration. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +changes will only take effect on Pods created after the update. Draining +the node is recommended before changing this field. +Default: "/etc/resolv.conf"
    runOnce
    +bool +
    + RunOnce causes the Kubelet to check the API server once for pods, +run those in addition to the pods specified by static pod files, and exit. +Default: false
    cpuCFSQuota
    +bool +
    + cpuCFSQuota enables CPU CFS quota enforcement for containers that +specify CPU limits. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +disabling it may reduce node stability. +Default: true
    cpuCFSQuotaPeriod
    +meta/v1.Duration +
    + CPUCFSQuotaPeriod is the CPU CFS quota period value, cpu.cfs_period_us. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +limits set for containers will result in different cpu.cfs_quota settings. This +will trigger container restarts on the node being reconfigured. +Default: "100ms"
    nodeStatusMaxImages
    +int32 +
    + nodeStatusMaxImages caps the number of images reported in Node.Status.Images. +Note: If -1 is specified, no cap will be applied. If 0 is specified, no image is returned. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +different values can be reported on node status. +Default: 50
    maxOpenFiles
    +int64 +
    + maxOpenFiles is Number of files that can be opened by Kubelet process. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may impact the ability of the Kubelet to interact with the node's filesystem. +Default: 1000000
    contentType
    +string +
    + contentType is contentType of requests sent to apiserver. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may impact the ability for the Kubelet to communicate with the API server. +If the Kubelet loses contact with the API server due to a change to this field, +the change cannot be reverted via dynamic Kubelet config. +Default: "application/vnd.kubernetes.protobuf"
    kubeAPIQPS
    +int32 +
    + kubeAPIQPS is the QPS to use while talking with kubernetes apiserver +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may impact scalability by changing the amount of traffic the Kubelet +sends to the API server. +Default: 5
    kubeAPIBurst
    +int32 +
    + kubeAPIBurst is the burst to allow while talking with kubernetes apiserver +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may impact scalability by changing the amount of traffic the Kubelet +sends to the API server. +Default: 10
    serializeImagePulls
    +bool +
    + serializeImagePulls when enabled, tells the Kubelet to pull images one +at a time. We recommend ∗not∗ changing the default value on nodes that +run docker daemon with version < 1.9 or an Aufs storage backend. +Issue #10959 has more details. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may impact the performance of image pulls. +Default: true
    evictionHard
    +map[string]string +
    + Map of signal names to quantities that defines hard eviction thresholds. For example: {"memory.available": "300Mi"}. +To explicitly disable, pass a 0% or 100% threshold on an arbitrary resource. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may trigger or delay Pod evictions. +Default: + memory.available: "100Mi" + nodefs.available: "10%" + nodefs.inodesFree: "5%" + imagefs.available: "15%"
    evictionSoft
    +map[string]string +
    + Map of signal names to quantities that defines soft eviction thresholds. +For example: {"memory.available": "300Mi"}. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may trigger or delay Pod evictions, and may change the allocatable reported +by the node. +Default: nil
    evictionSoftGracePeriod
    +map[string]string +
    + Map of signal names to quantities that defines grace periods for each soft eviction signal. +For example: {"memory.available": "30s"}. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may trigger or delay Pod evictions. +Default: nil
    evictionPressureTransitionPeriod
    +meta/v1.Duration +
    + Duration for which the kubelet has to wait before transitioning out of an eviction pressure condition. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +lowering it may decrease the stability of the node when the node is overcommitted. +Default: "5m"
    evictionMaxPodGracePeriod
    +int32 +
    + Maximum allowed grace period (in seconds) to use when terminating pods in +response to a soft eviction threshold being met. This value effectively caps +the Pod's TerminationGracePeriodSeconds value during soft evictions. +Note: Due to issue #64530, the behavior has a bug where this value currently just +overrides the grace period during soft eviction, which can increase the grace +period from what is set on the Pod. This bug will be fixed in a future release. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +lowering it decreases the amount of time Pods will have to gracefully clean +up before being killed during a soft eviction. +Default: 0
    evictionMinimumReclaim
    +map[string]string +
    + Map of signal names to quantities that defines minimum reclaims, which describe the minimum +amount of a given resource the kubelet will reclaim when performing a pod eviction while +that resource is under pressure. For example: {"imagefs.available": "2Gi"} +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may change how well eviction can manage resource pressure. +Default: nil
    podsPerCore
    +int32 +
    + podsPerCore is the maximum number of pods per core. Cannot exceed MaxPods. +If 0, this field is ignored. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +changes may cause Pods to fail admission on Kubelet restart, and may change +the value reported in Node.Status.Capacity[v1.ResourcePods], thus affecting +future scheduling decisions. Increasing this value may also decrease performance, +as more Pods can be packed into a single node. +Default: 0
    enableControllerAttachDetach
    +bool +
    + enableControllerAttachDetach enables the Attach/Detach controller to +manage attachment/detachment of volumes scheduled to this node, and +disables kubelet from executing any attach/detach operations +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +changing which component is responsible for volume management on a live node +may result in volumes refusing to detach if the node is not drained prior to +the update, and if Pods are scheduled to the node before the +volumes.kubernetes.io/controller-managed-attach-detach annotation is updated by the +Kubelet. In general, it is safest to leave this value set the same as local config. +Default: true
    protectKernelDefaults
    +bool +
    + protectKernelDefaults, if true, causes the Kubelet to error if kernel +flags are not as it expects. Otherwise the Kubelet will attempt to modify +kernel flags to match its expectation. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +enabling it may cause the Kubelet to crash-loop if the Kernel is not configured as +Kubelet expects. +Default: false
    makeIPTablesUtilChains
    +bool +
    + If true, Kubelet ensures a set of iptables rules are present on host. +These rules will serve as utility rules for various components, e.g. KubeProxy. +The rules will be created based on IPTablesMasqueradeBit and IPTablesDropBit. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +disabling it will prevent the Kubelet from healing locally misconfigured iptables rules. +Default: true
    iptablesMasqueradeBit
    +int32 +
    + iptablesMasqueradeBit is the bit of the iptables fwmark space to mark for SNAT +Values must be within the range [0, 31]. Must be different from other mark bits. +Warning: Please match the value of the corresponding parameter in kube-proxy. +TODO: clean up IPTablesMasqueradeBit in kube-proxy +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it needs to be coordinated with other components, like kube-proxy, and the update +will only be effective if MakeIPTablesUtilChains is enabled. +Default: 14
    iptablesDropBit
    +int32 +
    + iptablesDropBit is the bit of the iptables fwmark space to mark for dropping packets. +Values must be within the range [0, 31]. Must be different from other mark bits. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it needs to be coordinated with other components, like kube-proxy, and the update +will only be effective if MakeIPTablesUtilChains is enabled. +Default: 15
    featureGates
    +map[string]bool +
    + featureGates is a map of feature names to bools that enable or disable alpha/experimental +features. This field modifies piecemeal the built-in default values from +"k8s.io/kubernetes/pkg/features/kube_features.go". +Dynamic Kubelet Config (beta): If dynamically updating this field, consider the +documentation for the features you are enabling or disabling. While we +encourage feature developers to make it possible to dynamically enable +and disable features, some changes may require node reboots, and some +features may require careful coordination to retroactively disable. +Default: nil
    failSwapOn
    +bool +
    + failSwapOn tells the Kubelet to fail to start if swap is enabled on the node. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +setting it to true will cause the Kubelet to crash-loop if swap is enabled. +Default: true
    containerLogMaxSize
    +string +
    + A quantity defines the maximum size of the container log file before it is rotated. +For example: "5Mi" or "256Ki". +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may trigger log rotation. +Default: "10Mi"
    containerLogMaxFiles
    +int32 +
    + Maximum number of container log files that can be present for a container. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +lowering it may cause log files to be deleted. +Default: 5
    configMapAndSecretChangeDetectionStrategy
    +ResourceChangeDetectionStrategy +
    + ConfigMapAndSecretChangeDetectionStrategy is a mode in which +config map and secret managers are running. +Default: "Watch"
    systemReserved
    +map[string]string +
    + systemReserved is a set of ResourceName=ResourceQuantity (e.g. cpu=200m,memory=150G) +pairs that describe resources reserved for non-kubernetes components. +Currently only cpu and memory are supported. +See http://kubernetes.io/docs/user-guide/compute-resources for more detail. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may not be possible to increase the reserved resources, because this +requires resizing cgroups. Always look for a NodeAllocatableEnforced event +after updating this field to ensure that the update was successful. +Default: nil
    kubeReserved
    +map[string]string +
    + A set of ResourceName=ResourceQuantity (e.g. cpu=200m,memory=150G) pairs +that describe resources reserved for kubernetes system components. +Currently cpu, memory and local storage for root file system are supported. +See http://kubernetes.io/docs/user-guide/compute-resources for more detail. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may not be possible to increase the reserved resources, because this +requires resizing cgroups. Always look for a NodeAllocatableEnforced event +after updating this field to ensure that the update was successful. +Default: nil
    reservedSystemCPUs [Required]
    +string +
    + This ReservedSystemCPUs option specifies the cpu list reserved for the host level system threads and kubernetes related threads. +This provide a "static" CPU list rather than the "dynamic" list by system-reserved and kube-reserved. +This option overwrites CPUs provided by system-reserved and kube-reserved.
    showHiddenMetricsForVersion
    +string +
    + The previous version for which you want to show hidden metrics. +Only the previous minor version is meaningful, other values will not be allowed. +The format is ., e.g.: '1.16'. +The purpose of this format is make sure you have the opportunity to notice if the next release hides additional metrics, +rather than being surprised when they are permanently removed in the release after that. +Default: ""
    systemReservedCgroup
    +string +
    + This flag helps kubelet identify absolute name of top level cgroup used to enforce `SystemReserved` compute resource reservation for OS system daemons. +Refer to [Node Allocatable](https://git.k8s.io/community/contributors/design-proposals/node/node-allocatable.md) doc for more information. +Dynamic Kubelet Config (beta): This field should not be updated without a full node +reboot. It is safest to keep this value the same as the local config. +Default: ""
    kubeReservedCgroup
    +string +
    + This flag helps kubelet identify absolute name of top level cgroup used to enforce `KubeReserved` compute resource reservation for Kubernetes node system daemons. +Refer to [Node Allocatable](https://git.k8s.io/community/contributors/design-proposals/node/node-allocatable.md) doc for more information. +Dynamic Kubelet Config (beta): This field should not be updated without a full node +reboot. It is safest to keep this value the same as the local config. +Default: ""
    enforceNodeAllocatable
    +[]string +
    + This flag specifies the various Node Allocatable enforcements that Kubelet needs to perform. +This flag accepts a list of options. Acceptable options are `none`, `pods`, `system-reserved` & `kube-reserved`. +If `none` is specified, no other options may be specified. +Refer to [Node Allocatable](https://git.k8s.io/community/contributors/design-proposals/node/node-allocatable.md) doc for more information. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +removing enforcements may reduce the stability of the node. Alternatively, adding +enforcements may reduce the stability of components which were using more than +the reserved amount of resources; for example, enforcing kube-reserved may cause +Kubelets to OOM if it uses more than the reserved resources, and enforcing system-reserved +may cause system daemons to OOM if they use more than the reserved resources. +Default: ["pods"]
    allowedUnsafeSysctls
    +[]string +
    + A comma separated whitelist of unsafe sysctls or sysctl patterns (ending in ∗). +Unsafe sysctl groups are kernel.shm∗, kernel.msg∗, kernel.sem, fs.mqueue.∗, and net.∗. +These sysctls are namespaced but not allowed by default. For example: "kernel.msg∗,net.ipv4.route.min_pmtu" +Default: []
    volumePluginDir
    +string +
    + volumePluginDir is the full path of the directory in which to search +for additional third party volume plugins. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that changing +the volumePluginDir may disrupt workloads relying on third party volume plugins. +Default: "/usr/libexec/kubernetes/kubelet-plugins/volume/exec/"
    providerID
    +string +
    + providerID, if set, sets the unique id of the instance that an external provider (i.e. cloudprovider) +can use to identify a specific node. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may impact the ability of the Kubelet to interact with cloud providers. +Default: ""
    kernelMemcgNotification
    +bool +
    + kernelMemcgNotification, if set, the kubelet will integrate with the kernel memcg notification +to determine if memory eviction thresholds are crossed rather than polling. +Dynamic Kubelet Config (beta): If dynamically updating this field, consider that +it may impact the way Kubelet interacts with the kernel. +Default: false
    logging [Required]
    +LoggingConfiguration +
    + Logging specifies the options of logging. +Refer [Logs Options](https://github.com/kubernetes/component-base/blob/master/logs/options.go) for more information. +Defaults: + Format: text
    enableSystemLogHandler
    +bool +
    + enableSystemLogHandler enables system logs via web interface host:port/logs/ +Default: true
    shutdownGracePeriod
    +meta/v1.Duration +
    + ShutdownGracePeriod specifies the total duration that the node should delay the shutdown and total grace period for pod termination during a node shutdown. +Default: "30s"
    shutdownGracePeriodCriticalPods
    +meta/v1.Duration +
    + ShutdownGracePeriodCriticalPods specifies the duration used to terminate critical pods during a node shutdown. This should be less than ShutdownGracePeriod. +For example, if ShutdownGracePeriod=30s, and ShutdownGracePeriodCriticalPods=10s, during a node shutdown the first 20 seconds would be reserved for gracefully terminating normal pods, and the last 10 seconds would be reserved for terminating critical pods. +Default: "10s"
    + + + +## `SerializedNodeConfigSource` {#kubelet-config-k8s-io-v1beta1-SerializedNodeConfigSource} + + + + + +SerializedNodeConfigSource allows us to serialize v1.NodeConfigSource. +This type is used internally by the Kubelet for tracking checkpointed dynamic configs. +It exists in the kubeletconfig API group because it is classified as a versioned input to the Kubelet. + + + + + + + + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    kubelet.config.k8s.io/v1beta1
    kind
    string
    SerializedNodeConfigSource
    source
    +core/v1.NodeConfigSource +
    + Source is the source that we are serializing
    + + + +## `HairpinMode` {#kubelet-config-k8s-io-v1beta1-HairpinMode} + +(Alias of `string`) + + + +HairpinMode denotes how the kubelet should configure networking to handle +hairpin packets. + + + + + +## `KubeletAnonymousAuthentication` {#kubelet-config-k8s-io-v1beta1-KubeletAnonymousAuthentication} + + + + +**Appears in:** + +- [KubeletAuthentication](#kubelet-config-k8s-io-v1beta1-KubeletAuthentication) + + + + + + + + + + + + + + + + +
    FieldDescription
    enabled
    +bool +
    + enabled allows anonymous requests to the kubelet server. +Requests that are not rejected by another authentication method are treated as anonymous requests. +Anonymous requests have a username of system:anonymous, and a group name of system:unauthenticated.
    + + + +## `KubeletAuthentication` {#kubelet-config-k8s-io-v1beta1-KubeletAuthentication} + + + + +**Appears in:** + +- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration) + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    x509
    +KubeletX509Authentication +
    + x509 contains settings related to x509 client certificate authentication
    webhook
    +KubeletWebhookAuthentication +
    + webhook contains settings related to webhook bearer token authentication
    anonymous
    +KubeletAnonymousAuthentication +
    + anonymous contains settings related to anonymous authentication
    + + + +## `KubeletAuthorization` {#kubelet-config-k8s-io-v1beta1-KubeletAuthorization} + + + + +**Appears in:** + +- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration) + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    mode
    +KubeletAuthorizationMode +
    + mode is the authorization mode to apply to requests to the kubelet server. +Valid values are AlwaysAllow and Webhook. +Webhook mode uses the SubjectAccessReview API to determine authorization.
    webhook
    +KubeletWebhookAuthorization +
    + webhook contains settings related to Webhook authorization.
    + + + +## `KubeletAuthorizationMode` {#kubelet-config-k8s-io-v1beta1-KubeletAuthorizationMode} + +(Alias of `string`) + + +**Appears in:** + +- [KubeletAuthorization](#kubelet-config-k8s-io-v1beta1-KubeletAuthorization) + + + + + + + + +## `KubeletWebhookAuthentication` {#kubelet-config-k8s-io-v1beta1-KubeletWebhookAuthentication} + + + + +**Appears in:** + +- [KubeletAuthentication](#kubelet-config-k8s-io-v1beta1-KubeletAuthentication) + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    enabled
    +bool +
    + enabled allows bearer token authentication backed by the tokenreviews.authentication.k8s.io API
    cacheTTL
    +meta/v1.Duration +
    + cacheTTL enables caching of authentication results
    + + + +## `KubeletWebhookAuthorization` {#kubelet-config-k8s-io-v1beta1-KubeletWebhookAuthorization} + + + + +**Appears in:** + +- [KubeletAuthorization](#kubelet-config-k8s-io-v1beta1-KubeletAuthorization) + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    cacheAuthorizedTTL
    +meta/v1.Duration +
    + cacheAuthorizedTTL is the duration to cache 'authorized' responses from the webhook authorizer.
    cacheUnauthorizedTTL
    +meta/v1.Duration +
    + cacheUnauthorizedTTL is the duration to cache 'unauthorized' responses from the webhook authorizer.
    + + + +## `KubeletX509Authentication` {#kubelet-config-k8s-io-v1beta1-KubeletX509Authentication} + + + + +**Appears in:** + +- [KubeletAuthentication](#kubelet-config-k8s-io-v1beta1-KubeletAuthentication) + + + + + + + + + + + + + + + + +
    FieldDescription
    clientCAFile
    +string +
    + clientCAFile is the path to a PEM-encoded certificate bundle. If set, any request presenting a client certificate +signed by one of the authorities in the bundle is authenticated with a username corresponding to the CommonName, +and groups corresponding to the Organization in the client certificate.
    + + + +## `ResourceChangeDetectionStrategy` {#kubelet-config-k8s-io-v1beta1-ResourceChangeDetectionStrategy} + +(Alias of `string`) + + +**Appears in:** + +- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration) + + +ResourceChangeDetectionStrategy denotes a mode in which internal +managers (secret, configmap) are discovering object changes. + + + + + + + +## `LoggingConfiguration` {#LoggingConfiguration} + + + + +**Appears in:** + +- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration) + + +LoggingConfiguration contains logging options +Refer [Logs Options](https://github.com/kubernetes/component-base/blob/master/logs/options.go) for more information. + + + + + + + + + + + + + + + + + + +
    FieldDescription
    format [Required]
    +string +
    + Format Flag specifies the structure of log messages. +default value of format is `text`
    sanitization [Required]
    +bool +
    + [Experimental] When enabled prevents logging of fields tagged as sensitive (passwords, keys, tokens). +Runtime log sanitization may introduce significant computation overhead and therefore should not be enabled in production.`)
    diff --git a/content/en/docs/reference/setup-tools/kubeadm/implementation-details.md b/content/en/docs/reference/setup-tools/kubeadm/implementation-details.md index 5a321ec670..7159fc765d 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/implementation-details.md +++ b/content/en/docs/reference/setup-tools/kubeadm/implementation-details.md @@ -251,7 +251,7 @@ Other API server flags that are set unconditionally are: - `--requestheader-client-ca-file` to`front-proxy-ca.crt` - `--proxy-client-cert-file` to `front-proxy-client.crt` - `--proxy-client-key-file` to `front-proxy-client.key` - - Other flags for securing the front proxy ([API Aggregation](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/aggregated-api-servers.md)) communications: + - Other flags for securing the front proxy ([API Aggregation](/docs/concepts/extend-kubernetes/api-extension/apiserver-aggregation/)) communications: - `--requestheader-username-headers=X-Remote-User` - `--requestheader-group-headers=X-Remote-Group` - `--requestheader-extra-headers-prefix=X-Remote-Extra-` @@ -305,7 +305,7 @@ into `/var/lib/kubelet/config/init/kubelet` file. The init configuration is used for starting the kubelet on this specific node, providing an alternative for the kubelet drop-in file; such configuration will be replaced by the kubelet base configuration as described in following steps. -See [set Kubelet parameters via a config file](/docs/tasks/administer-cluster/kubelet-config-file) for additional info. +See [set kubelet parameters via a config file](/docs/tasks/administer-cluster/kubelet-config-file) for additional information. Please note that: @@ -315,6 +315,9 @@ Please note that: a configuration file `--config some-file.yaml`. The `KubeletConfiguration` object can be separated from other objects such as `InitConfiguration` using the `---` separator. For more details have a look at the `kubeadm config print-default` command. +For more details about the `KubeletConfiguration` struct, take a look at the +[`KubeletConfiguration` reference](/docs/reference/config-api/kubelet-config.v1beta1/). + ### Wait for the control plane to come up kubeadm waits (upto 4m0s) until `localhost:6443/healthz` (kube-apiserver liveness) returns `ok`. However in order to detect @@ -325,7 +328,8 @@ kubeadm relies on the kubelet to pull the control plane images and run them prop After the control plane is up, kubeadm completes the tasks described in following paragraphs. ### (optional) Write base kubelet configuration -{{< feature-state for_k8s_version="v1.9" state="alpha" >}} + +{{< feature-state for_k8s_version="v1.11" state="beta" >}} If kubeadm is invoked with `--feature-gates=DynamicKubeletConfig`: @@ -438,8 +442,8 @@ A ServiceAccount for `kube-proxy` is created in the `kube-system` namespace; the - In Kubernetes version 1.18 kube-dns usage with kubeadm is deprecated and will be removed in a future release - The CoreDNS service is named `kube-dns`. This is done to prevent any interruption -in service when the user is switching the cluster DNS from kube-dns to CoreDNS or vice-versa -the `--config` method described [here](/docs/reference/setup-tools/kubeadm/kubeadm-init-phase/#cmd-phase-addon) + in service when the user is switching the cluster DNS from kube-dns to CoreDNS or vice-versa + the `--config` method described [here](/docs/reference/setup-tools/kubeadm/kubeadm-init-phase/#cmd-phase-addon) - A ServiceAccount for CoreDNS/kube-dns is created in the `kube-system` namespace. - The `kube-dns` ServiceAccount is bound to the privileges in the `system:kube-dns` ClusterRole @@ -499,10 +503,9 @@ when the connection with the cluster is established, kubeadm try to access the ` ## TLS Bootstrap -Once the cluster info are known, the file `bootstrap-kubelet.conf` is written, thus allowing kubelet to do TLS Bootstrapping -(conversely until v.1.7 TLS bootstrapping were managed by kubeadm). +Once the cluster info are known, the file `bootstrap-kubelet.conf` is written, thus allowing kubelet to do TLS Bootstrapping. -The TLS bootstrap mechanism uses the shared token to temporarily authenticate with the Kubernetes Master to submit a certificate +The TLS bootstrap mechanism uses the shared token to temporarily authenticate with the Kubernetes API server to submit a certificate signing request (CSR) for a locally created key pair. The request is then automatically approved and the operation completes saving `ca.crt` file and `kubelet.conf` file to be used @@ -512,17 +515,17 @@ Please note that: - The temporary authentication is validated against the token saved during the `kubeadm init` process (or with additional tokens created with `kubeadm token`) -- The temporary authentication resolve to a user member of `system:bootstrappers:kubeadm:default-node-token` group which was granted +- The temporary authentication resolve to a user member of `system:bootstrappers:kubeadm:default-node-token` group which was granted access to CSR api during the `kubeadm init` process - The automatic CSR approval is managed by the csrapprover controller, according with configuration done the `kubeadm init` process ### (optional) Write init kubelet configuration -{{< feature-state for_k8s_version="v1.9" state="alpha" >}} +{{< feature-state for_k8s_version="v1.11" state="beta" >}} If kubeadm is invoked with `--feature-gates=DynamicKubeletConfig`: -1. Read the kubelet base configuration from the `kubelet-base-config-v1.9` ConfigMap in the `kube-system` namespace using the +1. Read the kubelet base configuration from the `kubelet-base-config-v1.x` ConfigMap in the `kube-system` namespace using the Bootstrap Token credentials, and write it to disk as kubelet init configuration file `/var/lib/kubelet/config/init/kubelet` 2. As soon as kubelet starts with the Node's own credential (`/etc/kubernetes/kubelet.conf`), update current node configuration specifying that the source for the node/kubelet configuration is the above ConfigMap. diff --git a/content/en/docs/setup/production-environment/tools/kubeadm/install-kubeadm.md b/content/en/docs/setup/production-environment/tools/kubeadm/install-kubeadm.md index 4f9d9c6ce7..ea144e1dae 100644 --- a/content/en/docs/setup/production-environment/tools/kubeadm/install-kubeadm.md +++ b/content/en/docs/setup/production-environment/tools/kubeadm/install-kubeadm.md @@ -71,7 +71,7 @@ For more details please see the [Network Plugin Requirements](/docs/concepts/ext | Protocol | Direction | Port Range | Purpose | Used By | |----------|-----------|------------|-------------------------|---------------------------| -| TCP | Inbound | 6443* | Kubernetes API server | All | +| TCP | Inbound | 6443\* | Kubernetes API server | All | | TCP | Inbound | 2379-2380 | etcd server client API | kube-apiserver, etcd | | TCP | Inbound | 10250 | kubelet API | Self, Control plane | | TCP | Inbound | 10251 | kube-scheduler | Self | @@ -308,7 +308,8 @@ kind: KubeletConfiguration cgroupDriver: ``` -For further details, please read [Using kubeadm init with a configuration file](/docs/reference/setup-tools/kubeadm/kubeadm-init/#config-file). +For further details, please read [Using kubeadm init with a configuration file](/docs/reference/setup-tools/kubeadm/kubeadm-init/#config-file) +and the [`KubeletConfiguration` reference](/docs/reference/config-api/kubelet-config.v1beta1/) Please mind, that you **only** have to do that if the cgroup driver of your CRI is not `cgroupfs`, because that is the default value in the kubelet already. @@ -322,12 +323,11 @@ or `/etc/default/kubelet`(`/etc/sysconfig/kubelet` for RPMs), please remove it a The automatic detection of cgroup driver for other container runtimes like CRI-O and containerd is work in progress. - ## Troubleshooting If you are running into difficulties with kubeadm, please consult our [troubleshooting docs](/docs/setup/production-environment/tools/kubeadm/troubleshooting-kubeadm/). ## {{% heading "whatsnext" %}} - * [Using kubeadm to Create a Cluster](/docs/setup/production-environment/tools/kubeadm/create-cluster-kubeadm/) + diff --git a/content/en/docs/setup/production-environment/tools/kubeadm/kubelet-integration.md b/content/en/docs/setup/production-environment/tools/kubeadm/kubelet-integration.md index f68b026ccb..dda9aba77a 100644 --- a/content/en/docs/setup/production-environment/tools/kubeadm/kubelet-integration.md +++ b/content/en/docs/setup/production-environment/tools/kubeadm/kubelet-integration.md @@ -23,10 +23,8 @@ manager instead, but you need to configure it manually. Some kubelet configuration details need to be the same across all kubelets involved in the cluster, while other configuration aspects need to be set on a per-kubelet basis to accommodate the different characteristics of a given machine (such as OS, storage, and networking). You can manage the configuration -of your kubelets manually, but kubeadm now provides a `KubeletConfiguration` API type for [managing your -kubelet configurations centrally](#configure-kubelets-using-kubeadm). - - +of your kubelets manually, but kubeadm now provides a `KubeletConfiguration` API type for +[managing your kubelet configurations centrally](#configure-kubelets-using-kubeadm). @@ -52,8 +50,9 @@ Virtual IPs for services are now allocated from this subnet. You also need to se by the kubelet, using the `--cluster-dns` flag. This setting needs to be the same for every kubelet on every manager and Node in the cluster. The kubelet provides a versioned, structured API object that can configure most parameters in the kubelet and push out this configuration to each running -kubelet in the cluster. This object is called **the kubelet's ComponentConfig**. -The ComponentConfig allows the user to specify flags such as the cluster DNS IP addresses expressed as +kubelet in the cluster. This object is called +[`KubeletConfiguration`](/docs/reference/config-api/kubelet-config.v1beta1/). +The `KubeletConfiguration` allows the user to specify flags such as the cluster DNS IP addresses expressed as a list of values to a camelCased key, illustrated by the following example: ```yaml @@ -63,7 +62,7 @@ clusterDNS: - 10.96.0.10 ``` -For more details on the ComponentConfig have a look at [this section](#configure-kubelets-using-kubeadm). +For more details on the `KubeletConfiguration` have a look at [this section](#configure-kubelets-using-kubeadm). ### Providing instance-specific configuration details @@ -99,8 +98,8 @@ API object is passed with a configuration file like so `kubeadm ... --config som By calling `kubeadm config print init-defaults --component-configs KubeletConfiguration` you can see all the default values for this structure. -Also have a look at the [API reference for the -kubelet ComponentConfig](https://godoc.org/k8s.io/kubernetes/pkg/kubelet/apis/config#KubeletConfiguration) +Also have a look at the +[reference for the KubeletConfiguration](/docs/reference/config-api/kubelet-config.v1beta1/) for more information on the individual fields. ### Workflow when using `kubeadm init` @@ -160,9 +159,13 @@ has finished performing the TLS Bootstrap. `kubeadm` ships with configuration for how systemd should run the kubelet. Note that the kubeadm CLI command never touches this drop-in file. -This configuration file installed by the `kubeadm` [DEB](https://github.com/kubernetes/release/blob/master/cmd/kubepkg/templates/latest/deb/kubeadm/10-kubeadm.conf) or [RPM package](https://github.com/kubernetes/release/blob/master/cmd/kubepkg/templates/latest/rpm/kubeadm/10-kubeadm.conf) is written to +This configuration file installed by the `kubeadm` +[DEB](https://github.com/kubernetes/release/blob/master/cmd/kubepkg/templates/latest/deb/kubeadm/10-kubeadm.conf) or +[RPM package](https://github.com/kubernetes/release/blob/master/cmd/kubepkg/templates/latest/rpm/kubeadm/10-kubeadm.conf) is written to `/etc/systemd/system/kubelet.service.d/10-kubeadm.conf` and is used by systemd. -It augments the basic [`kubelet.service` for RPM](https://github.com/kubernetes/release/blob/master/cmd/kubepkg/templates/latest/rpm/kubelet/kubelet.service) or [`kubelet.service` for DEB](https://github.com/kubernetes/release/blob/master/cmd/kubepkg/templates/latest/deb/kubelet/lib/systemd/system/kubelet.service): +It augments the basic +[`kubelet.service` for RPM](https://github.com/kubernetes/release/blob/master/cmd/kubepkg/templates/latest/rpm/kubelet/kubelet.service) or +[`kubelet.service` for DEB](https://github.com/kubernetes/release/blob/master/cmd/kubepkg/templates/latest/deb/kubelet/lib/systemd/system/kubelet.service): ```none [Service] diff --git a/content/en/docs/setup/production-environment/tools/kubeadm/troubleshooting-kubeadm.md b/content/en/docs/setup/production-environment/tools/kubeadm/troubleshooting-kubeadm.md index 28ef3d3038..58f4f4652a 100644 --- a/content/en/docs/setup/production-environment/tools/kubeadm/troubleshooting-kubeadm.md +++ b/content/en/docs/setup/production-environment/tools/kubeadm/troubleshooting-kubeadm.md @@ -99,10 +99,11 @@ This may be caused by a number of problems. The most common are: There are two common ways to fix the cgroup driver problem: - 1. Install Docker again following instructions - [here](/docs/setup/production-environment/container-runtimes/#docker). + 1. Install Docker again following instructions + [here](/docs/setup/production-environment/container-runtimes/#docker). - 1. Change the kubelet config to match the Docker cgroup driver manually, you can refer to [Configure cgroup driver used by kubelet on control-plane node](/docs/setup/production-environment/tools/kubeadm/install-kubeadm/#configure-cgroup-driver-used-by-kubelet-on-control-plane-node) + 1. Change the kubelet config to match the Docker cgroup driver manually, you can refer to + [Configure cgroup driver used by kubelet on control-plane node](/docs/setup/production-environment/tools/kubeadm/install-kubeadm/#configure-cgroup-driver-used-by-kubelet-on-control-plane-node) - control plane Docker containers are crashlooping or hanging. You can check this by running `docker ps` and investigating each container by running `docker logs`. @@ -110,8 +111,11 @@ This may be caused by a number of problems. The most common are: The following could happen if Docker halts and does not remove any Kubernetes-managed containers: -```bash +```shell sudo kubeadm reset +``` + +```console [preflight] Running pre-flight checks [reset] Stopping the kubelet service [reset] Unmounting mounted directories in "/var/lib/kubelet" @@ -121,14 +125,14 @@ sudo kubeadm reset A possible solution is to restart the Docker service and then re-run `kubeadm reset`: -```bash +```shell sudo systemctl restart docker.service sudo kubeadm reset ``` Inspecting the logs for docker may also be useful: -```sh +```shell journalctl -u docker ``` @@ -415,3 +419,4 @@ If `/var/lib/kubelet` is being mounted, performing a `kubeadm reset` will effect To workaround the issue, re-mount the `/var/lib/kubelet` directory after performing the `kubeadm reset` operation. This is a regression introduced in kubeadm 1.15. The issue is fixed in 1.20. + diff --git a/content/en/docs/tasks/administer-cluster/kubelet-config-file.md b/content/en/docs/tasks/administer-cluster/kubelet-config-file.md index 252e140097..b49c84220a 100644 --- a/content/en/docs/tasks/administer-cluster/kubelet-config-file.md +++ b/content/en/docs/tasks/administer-cluster/kubelet-config-file.md @@ -7,31 +7,21 @@ content_type: task --- -{{< feature-state for_k8s_version="v1.10" state="beta" >}} A subset of the Kubelet's configuration parameters may be set via an on-disk config file, as a substitute for command-line flags. -This functionality is considered beta in v1.10. Providing parameters via a config file is the recommended approach because it simplifies node deployment and configuration management. - - -## {{% heading "prerequisites" %}} - - -- A v1.10 or higher Kubelet binary must be installed for beta functionality. - - - ## Create the config file The subset of the Kubelet's configuration that can be configured via a file -is defined by the `KubeletConfiguration` struct -[here (v1beta1)](https://github.com/kubernetes/kubernetes/blob/{{< param "docsbranch" >}}/staging/src/k8s.io/kubelet/config/v1beta1/types.go). +is defined by the +[`KubeletConfiguration`](/docs/reference/config-api/kubelet-config.v1beta1/) +struct. The configuration file must be a JSON or YAML representation of the parameters in this struct. Make sure the Kubelet has read permissions on the file. @@ -73,8 +63,6 @@ If `--config` is provided and the values are not specified via the command line, defaults for the `KubeletConfiguration` version apply. In the above example, this version is `kubelet.config.k8s.io/v1beta1`. - - ## Relationship to Dynamic Kubelet Config @@ -83,5 +71,9 @@ If you are using the [Dynamic Kubelet Configuration](/docs/tasks/administer-clus feature, the combination of configuration provided via `--config` and any flags which override these values is considered the default "last known good" configuration by the automatic rollback mechanism. +## {{% heading "whatsnext" %}} +- Learn more about kubelet configuration by checking the + [`KubeletConfiguration`](/docs/reference/config-api/kubelet-config.v1beta1/) + reference. diff --git a/content/en/docs/tasks/administer-cluster/reconfigure-kubelet.md b/content/en/docs/tasks/administer-cluster/reconfigure-kubelet.md index 4f71db554a..4ec3b428d0 100644 --- a/content/en/docs/tasks/administer-cluster/reconfigure-kubelet.md +++ b/content/en/docs/tasks/administer-cluster/reconfigure-kubelet.md @@ -22,8 +22,8 @@ but this is unsafe for some parameters. Before deciding to change a parameter dynamically, you need a strong understanding of how that change will affect your cluster's behavior. Always carefully test configuration changes on a small set of nodes before rolling them out cluster-wide. Advice on configuring specific -fields is available in the inline `KubeletConfiguration` -[type documentation (for v1.20)](https://github.com/kubernetes/kubernetes/blob/release-1.20/staging/src/k8s.io/kubelet/config/v1beta1/types.go). +fields is available in the inline +[`KubeletConfiguration`](/docs/reference/config-api/kubelet-config.v1beta1/). {{< /warning >}} @@ -55,7 +55,7 @@ For each node that you're reconfiguring, you must set the kubelet The basic workflow for configuring a kubelet in a live cluster is as follows: 1. Write a YAML or JSON configuration file containing the -kubelet's configuration. + kubelet's configuration. 2. Wrap this file in a ConfigMap and save it to the Kubernetes control plane. 3. Update the kubelet's corresponding Node object to use this ConfigMap. @@ -135,24 +135,24 @@ To follow the tasks as written, you need to have `jq` installed. You can adapt the steps if you prefer to extract the `kubeletconfig` subobject manually. {{< /note >}} -1. Choose a Node to reconfigure. In this example, the name of this Node is - referred to as `NODE_NAME`. -2. Start the kubectl proxy in the background using the following command: +1. Choose a Node to reconfigure. In this example, the name of this Node is + referred to as `NODE_NAME`. +2. Start the kubectl proxy in the background using the following command: - ```bash - kubectl proxy --port=8001 & - ``` -3. Run the following command to download and unpack the configuration from the - `configz` endpoint. The command is long, so be careful when copying and - pasting. **If you use zsh**, note that common zsh configurations add backslashes - to escape the opening and closing curly braces around the variable name in the URL. - For example: `${NODE_NAME}` will be rewritten as `$\{NODE_NAME\}` during the paste. - You must remove the backslashes before running the command, or the command will fail. + ```shell + kubectl proxy --port=8001 & + ``` +3. Run the following command to download and unpack the configuration from the + `configz` endpoint. The command is long, so be careful when copying and + pasting. **If you use zsh**, note that common zsh configurations add backslashes + to escape the opening and closing curly braces around the variable name in the URL. + For example: `${NODE_NAME}` will be rewritten as `$\{NODE_NAME\}` during the paste. + You must remove the backslashes before running the command, or the command will fail. - ```bash - NODE_NAME="the-name-of-the-node-you-are-reconfiguring"; curl -sSL "http://localhost:8001/api/v1/nodes/${NODE_NAME}/proxy/configz" | jq '.kubeletconfig|.kind="KubeletConfiguration"|.apiVersion="kubelet.config.k8s.io/v1beta1"' > kubelet_configz_${NODE_NAME} - ``` + ```bash + NODE_NAME="the-name-of-the-node-you-are-reconfiguring"; curl -sSL "http://localhost:8001/api/v1/nodes/${NODE_NAME}/proxy/configz" | jq '.kubeletconfig|.kind="KubeletConfiguration"|.apiVersion="kubelet.config.k8s.io/v1beta1"' > kubelet_configz_${NODE_NAME} + ``` {{< note >}} You need to manually add the `kind` and `apiVersion` to the downloaded @@ -312,8 +312,6 @@ empty, since all config sources have been reset to `nil`, which indicates that the local default config is `assigned`, `active`, and `lastKnownGood`, and no error is reported. - - ## `kubectl patch` example @@ -356,7 +354,7 @@ metadata and checkpoints. The structure of the kubelet's checkpointing directory | - ... ``` -## Understanding Node.Status.Config.Error messages {#understanding-node-config-status-errors} +## Understanding `Node.Status.Config.Error` messages {#understanding-node-config-status-errors} The following table describes error messages that can occur when using Dynamic Kubelet Config. You can search for the identical text @@ -378,6 +376,10 @@ internal failure, see Kubelet log for details | The kubelet encountered some int ## {{% heading "whatsnext" %}} - - For more information on configuring the kubelet via a configuration file, see +- For more information on configuring the kubelet via a configuration file, see [Set kubelet parameters via a config file](/docs/tasks/administer-cluster/kubelet-config-file). - See the reference documentation for [`NodeConfigSource`](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#nodeconfigsource-v1-core) +- Learn more about kubelet configuration by checking the + [`KubeletConfiguration`](/docs/reference/config-api/kubelet-config.v1beta1/) + reference. + diff --git a/content/en/docs/tasks/configure-pod-container/static-pod.md b/content/en/docs/tasks/configure-pod-container/static-pod.md index 071c1614fc..9126243462 100644 --- a/content/en/docs/tasks/configure-pod-container/static-pod.md +++ b/content/en/docs/tasks/configure-pod-container/static-pod.md @@ -31,21 +31,14 @@ Pods to run a Pod on every node, you should probably be using a instead. {{< /note >}} - - ## {{% heading "prerequisites" %}} - {{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} This page assumes you're using {{< glossary_tooltip term_id="docker" >}} to run Pods, and that your nodes are running the Fedora operating system. Instructions for other distributions or Kubernetes installations may vary. - - - - ## Create a static pod {#static-pod-creation} @@ -54,7 +47,9 @@ You can configure a static Pod with either a [file system hosted configuration f ### Filesystem-hosted static Pod manifest {#configuration-files} -Manifests are standard Pod definitions in JSON or YAML format in a specific directory. Use the `staticPodPath: ` field in the [kubelet configuration file](/docs/tasks/administer-cluster/kubelet-config-file), which periodically scans the directory and creates/deletes static Pods as YAML/JSON files appear/disappear there. +Manifests are standard Pod definitions in JSON or YAML format in a specific directory. Use the `staticPodPath: ` field in the +[kubelet configuration file](/docs/reference/config-api/kubelet-config.v1beta1/), +which periodically scans the directory and creates/deletes static Pods as YAML/JSON files appear/disappear there. Note that the kubelet will ignore files starting with dots when scanning the specified directory. For example, this is how to start a simple web server as a static Pod: @@ -90,17 +85,18 @@ For example, this is how to start a simple web server as a static Pod: 3. Configure your kubelet on the node to use this directory by running it with `--pod-manifest-path=/etc/kubelet.d/` argument. On Fedora edit `/etc/kubernetes/kubelet` to include this line: - ``` - KUBELET_ARGS="--cluster-dns=10.254.0.10 --cluster-domain=kube.local --pod-manifest-path=/etc/kubelet.d/" - ``` - or add the `staticPodPath: ` field in the [kubelet configuration file](/docs/tasks/administer-cluster/kubelet-config-file). + ``` + KUBELET_ARGS="--cluster-dns=10.254.0.10 --cluster-domain=kube.local --pod-manifest-path=/etc/kubelet.d/" + ``` + or add the `staticPodPath: ` field in the + [kubelet configuration file](/docs/reference/config-api/kubelet-config.v1beta1/). 4. Restart the kubelet. On Fedora, you would run: - ```shell - # Run this command on the node where the kubelet is running - systemctl restart kubelet - ``` + ```shell + # Run this command on the node where the kubelet is running + systemctl restart kubelet + ``` ### Web-hosted static pod manifest {#pods-created-via-http} From ce76e0f875ed57697ab80ade6bda93e9a42f8181 Mon Sep 17 00:00:00 2001 From: Qiming Teng Date: Wed, 17 Feb 2021 21:22:09 +0800 Subject: [PATCH 089/104] Add reference for kube-scheduler config --- .../scheduling-eviction/kube-scheduler.md | 2 + .../scheduler-perf-tuning.md | 12 +- content/en/docs/reference/_index.md | 4 +- .../kube-scheduler-config.v1beta1.md | 2156 +++++++++++++++++ .../en/docs/reference/scheduling/config.md | 8 +- .../en/docs/reference/scheduling/policies.md | 4 +- 6 files changed, 2175 insertions(+), 11 deletions(-) create mode 100644 content/en/docs/reference/config-api/kube-scheduler-config.v1beta1.md diff --git a/content/en/docs/concepts/scheduling-eviction/kube-scheduler.md b/content/en/docs/concepts/scheduling-eviction/kube-scheduler.md index a3e548d237..0944ecc768 100644 --- a/content/en/docs/concepts/scheduling-eviction/kube-scheduler.md +++ b/content/en/docs/concepts/scheduling-eviction/kube-scheduler.md @@ -87,6 +87,7 @@ of the scheduler: * Read about [scheduler performance tuning](/docs/concepts/scheduling-eviction/scheduler-perf-tuning/) * Read about [Pod topology spread constraints](/docs/concepts/workloads/pods/pod-topology-spread-constraints/) * Read the [reference documentation](/docs/reference/command-line-tools-reference/kube-scheduler/) for kube-scheduler +* Read the [kube-scheduler config (v1beta1)](/docs/reference/config-api/kube-scheduler-config.v1beta1/) reference * Learn about [configuring multiple schedulers](/docs/tasks/extend-kubernetes/configure-multiple-schedulers/) * Learn about [topology management policies](/docs/tasks/administer-cluster/topology-manager/) * Learn about [Pod Overhead](/docs/concepts/scheduling-eviction/pod-overhead/) @@ -94,3 +95,4 @@ of the scheduler: * [Volume Topology Support](/docs/concepts/storage/storage-classes/#volume-binding-mode) * [Storage Capacity Tracking](/docs/concepts/storage/storage-capacity/) * [Node-specific Volume Limits](/docs/concepts/storage/storage-limits/) + diff --git a/content/en/docs/concepts/scheduling-eviction/scheduler-perf-tuning.md b/content/en/docs/concepts/scheduling-eviction/scheduler-perf-tuning.md index 7936f9dedc..24283f2efa 100644 --- a/content/en/docs/concepts/scheduling-eviction/scheduler-perf-tuning.md +++ b/content/en/docs/concepts/scheduling-eviction/scheduler-perf-tuning.md @@ -24,8 +24,6 @@ in a process called _Binding_. This page explains performance tuning optimizations that are relevant for large Kubernetes clusters. - - In large clusters, you can tune the scheduler's behaviour balancing @@ -44,8 +42,10 @@ should use its compiled-in default. If you set `percentageOfNodesToScore` above 100, kube-scheduler acts as if you had set a value of 100. -To change the value, edit the kube-scheduler configuration file (this is likely -to be `/etc/kubernetes/config/kube-scheduler.yaml`), then restart the scheduler. +To change the value, edit the +[kube-scheduler configuration file](/docs/reference/config-api/kube-scheduler-config.v1beta1/) +and then restart the scheduler. +In many cases, the configuration file can be found at `/etc/kubernetes/config/kube-scheduler.yaml`. After you have made this change, you can run @@ -99,7 +99,6 @@ algorithmSource: percentageOfNodesToScore: 50 ``` - ## Tuning percentageOfNodesToScore `percentageOfNodesToScore` must be a value between 1 and 100 with the default @@ -160,4 +159,7 @@ Node 1, Node 5, Node 2, Node 6, Node 3, Node 4 After going over all the Nodes, it goes back to Node 1. +## {{% heading "whatsnext" %}} + +* Check the [kube-scheduler configuration reference (v1beta1)](/docs/reference/config-api/kube-scheduler-config.v1beta1/) diff --git a/content/en/docs/reference/_index.md b/content/en/docs/reference/_index.md index 00adcad7d7..ba5e1d1ac7 100644 --- a/content/en/docs/reference/_index.md +++ b/content/en/docs/reference/_index.md @@ -22,8 +22,6 @@ This section of the Kubernetes documentation contains references. * [Glossary](/docs/reference/glossary/) - a comprehensive, standardized list of Kubernetes terminology - - * [Kubernetes API Reference](/docs/reference/kubernetes-api/) * [One-page API Reference for Kubernetes {{< param "version" >}}](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/) * [Using The Kubernetes API](/docs/reference/using-api/) - overview of the API for Kubernetes. @@ -65,6 +63,8 @@ client libraries: ## Config APIs * [kube-proxy configuration (v1alpha1)](/docs/reference/config-api/kube-proxy-config.v1alpha1/) +* [kube-scheduler config (v1beta1)](/docs/reference/config-api/kube-scheduler-config.v1beta1/) + ## Design Docs diff --git a/content/en/docs/reference/config-api/kube-scheduler-config.v1beta1.md b/content/en/docs/reference/config-api/kube-scheduler-config.v1beta1.md new file mode 100644 index 0000000000..ac32e65674 --- /dev/null +++ b/content/en/docs/reference/config-api/kube-scheduler-config.v1beta1.md @@ -0,0 +1,2156 @@ +--- +title: kube-scheduler Configuration (v1beta1) +content_type: tool-reference +package: kubescheduler.config.k8s.io/v1 +auto_generated: true +--- + + +## Resource Types + + +- [Policy](#kubescheduler-config-k8s-io-v1-Policy) +- [DefaultPreemptionArgs](#kubescheduler-config-k8s-io-v1beta1-DefaultPreemptionArgs) +- [InterPodAffinityArgs](#kubescheduler-config-k8s-io-v1beta1-InterPodAffinityArgs) +- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta1-KubeSchedulerConfiguration) +- [NodeAffinityArgs](#kubescheduler-config-k8s-io-v1beta1-NodeAffinityArgs) +- [NodeLabelArgs](#kubescheduler-config-k8s-io-v1beta1-NodeLabelArgs) +- [NodeResourcesFitArgs](#kubescheduler-config-k8s-io-v1beta1-NodeResourcesFitArgs) +- [NodeResourcesLeastAllocatedArgs](#kubescheduler-config-k8s-io-v1beta1-NodeResourcesLeastAllocatedArgs) +- [NodeResourcesMostAllocatedArgs](#kubescheduler-config-k8s-io-v1beta1-NodeResourcesMostAllocatedArgs) +- [PodTopologySpreadArgs](#kubescheduler-config-k8s-io-v1beta1-PodTopologySpreadArgs) +- [RequestedToCapacityRatioArgs](#kubescheduler-config-k8s-io-v1beta1-RequestedToCapacityRatioArgs) +- [ServiceAffinityArgs](#kubescheduler-config-k8s-io-v1beta1-ServiceAffinityArgs) +- [VolumeBindingArgs](#kubescheduler-config-k8s-io-v1beta1-VolumeBindingArgs) + + + + +## `Policy` {#kubescheduler-config-k8s-io-v1-Policy} + + + + + +Policy describes a struct for a policy resource used in api. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    kubescheduler.config.k8s.io/v1
    kind
    string
    Policy
    predicates [Required]
    +[]PredicatePolicy +
    + Holds the information to configure the fit predicate functions
    priorities [Required]
    +[]PriorityPolicy +
    + Holds the information to configure the priority functions
    extenders [Required]
    +[]LegacyExtender +
    + Holds the information to communicate with the extender(s)
    hardPodAffinitySymmetricWeight [Required]
    +int32 +
    + RequiredDuringScheduling affinity is not symmetric, but there is an implicit PreferredDuringScheduling affinity rule +corresponding to every RequiredDuringScheduling affinity rule. +HardPodAffinitySymmetricWeight represents the weight of implicit PreferredDuringScheduling affinity rule, in the range 1-100.
    alwaysCheckAllPredicates [Required]
    +bool +
    + When AlwaysCheckAllPredicates is set to true, scheduler checks all +the configured predicates even after one or more of them fails. +When the flag is set to false, scheduler skips checking the rest +of the predicates after it finds one predicate that failed.
    + + + +## `ExtenderManagedResource` {#kubescheduler-config-k8s-io-v1-ExtenderManagedResource} + + + + +**Appears in:** + +- [Extender](#kubescheduler-config-k8s-io-v1beta1-Extender) + +- [LegacyExtender](#kubescheduler-config-k8s-io-v1-LegacyExtender) + + +ExtenderManagedResource describes the arguments of extended resources +managed by an extender. + + + + + + + + + + + + + + + + + + +
    FieldDescription
    name [Required]
    +string +
    + Name is the extended resource name.
    ignoredByScheduler [Required]
    +bool +
    + IgnoredByScheduler indicates whether kube-scheduler should ignore this +resource when applying predicates.
    + + + +## `ExtenderTLSConfig` {#kubescheduler-config-k8s-io-v1-ExtenderTLSConfig} + + + + +**Appears in:** + +- [Extender](#kubescheduler-config-k8s-io-v1beta1-Extender) + +- [LegacyExtender](#kubescheduler-config-k8s-io-v1-LegacyExtender) + + +ExtenderTLSConfig contains settings to enable TLS with extender + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    insecure [Required]
    +bool +
    + Server should be accessed without verifying the TLS certificate. For testing only.
    serverName [Required]
    +string +
    + ServerName is passed to the server for SNI and is used in the client to check server +certificates against. If ServerName is empty, the hostname used to contact the +server is used.
    certFile [Required]
    +string +
    + Server requires TLS client certificate authentication
    keyFile [Required]
    +string +
    + Server requires TLS client certificate authentication
    caFile [Required]
    +string +
    + Trusted root certificates for server
    certData [Required]
    +[]byte +
    + CertData holds PEM-encoded bytes (typically read from a client certificate file). +CertData takes precedence over CertFile
    keyData [Required]
    +[]byte +
    + KeyData holds PEM-encoded bytes (typically read from a client certificate key file). +KeyData takes precedence over KeyFile
    caData [Required]
    +[]byte +
    + CAData holds PEM-encoded bytes (typically read from a root certificates bundle). +CAData takes precedence over CAFile
    + + + +## `LabelPreference` {#kubescheduler-config-k8s-io-v1-LabelPreference} + + + + +**Appears in:** + +- [PriorityArgument](#kubescheduler-config-k8s-io-v1-PriorityArgument) + + +LabelPreference holds the parameters that are used to configure the corresponding priority function + + + + + + + + + + + + + + + + + + +
    FieldDescription
    label [Required]
    +string +
    + Used to identify node "groups"
    presence [Required]
    +bool +
    + This is a boolean flag +If true, higher priority is given to nodes that have the label +If false, higher priority is given to nodes that do not have the label
    + + + +## `LabelsPresence` {#kubescheduler-config-k8s-io-v1-LabelsPresence} + + + + +**Appears in:** + +- [PredicateArgument](#kubescheduler-config-k8s-io-v1-PredicateArgument) + + +LabelsPresence holds the parameters that are used to configure the corresponding predicate in scheduler policy configuration. + + + + + + + + + + + + + + + + + + +
    FieldDescription
    labels [Required]
    +[]string +
    + The list of labels that identify node "groups" +All of the labels should be either present (or absent) for the node to be considered a fit for hosting the pod
    presence [Required]
    +bool +
    + The boolean flag that indicates whether the labels should be present or absent from the node
    + + + +## `LegacyExtender` {#kubescheduler-config-k8s-io-v1-LegacyExtender} + + + + +**Appears in:** + +- [Policy](#kubescheduler-config-k8s-io-v1-Policy) + + +LegacyExtender holds the parameters used to communicate with the extender. If a verb is unspecified/empty, +it is assumed that the extender chose not to provide that extension. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    urlPrefix [Required]
    +string +
    + URLPrefix at which the extender is available
    filterVerb [Required]
    +string +
    + Verb for the filter call, empty if not supported. This verb is appended to the URLPrefix when issuing the filter call to extender.
    preemptVerb [Required]
    +string +
    + Verb for the preempt call, empty if not supported. This verb is appended to the URLPrefix when issuing the preempt call to extender.
    prioritizeVerb [Required]
    +string +
    + Verb for the prioritize call, empty if not supported. This verb is appended to the URLPrefix when issuing the prioritize call to extender.
    weight [Required]
    +int64 +
    + The numeric multiplier for the node scores that the prioritize call generates. +The weight should be a positive integer
    bindVerb [Required]
    +string +
    + Verb for the bind call, empty if not supported. This verb is appended to the URLPrefix when issuing the bind call to extender. +If this method is implemented by the extender, it is the extender's responsibility to bind the pod to apiserver. Only one extender +can implement this function.
    enableHttps [Required]
    +bool +
    + EnableHTTPS specifies whether https should be used to communicate with the extender
    tlsConfig [Required]
    +ExtenderTLSConfig +
    + TLSConfig specifies the transport layer security config
    httpTimeout [Required]
    +time.Duration +
    + HTTPTimeout specifies the timeout duration for a call to the extender. Filter timeout fails the scheduling of the pod. Prioritize +timeout is ignored, k8s/other extenders priorities are used to select the node.
    nodeCacheCapable [Required]
    +bool +
    + NodeCacheCapable specifies that the extender is capable of caching node information, +so the scheduler should only send minimal information about the eligible nodes +assuming that the extender already cached full details of all nodes in the cluster
    managedResources
    +[]ExtenderManagedResource +
    + ManagedResources is a list of extended resources that are managed by +this extender. +- A pod will be sent to the extender on the Filter, Prioritize and Bind + (if the extender is the binder) phases iff the pod requests at least + one of the extended resources in this list. If empty or unspecified, + all pods will be sent to this extender. +- If IgnoredByScheduler is set to true for a resource, kube-scheduler + will skip checking the resource in predicates.
    ignorable [Required]
    +bool +
    + Ignorable specifies if the extender is ignorable, i.e. scheduling should not +fail when the extender returns an error or is not reachable.
    + + + +## `PredicateArgument` {#kubescheduler-config-k8s-io-v1-PredicateArgument} + + + + +**Appears in:** + +- [PredicatePolicy](#kubescheduler-config-k8s-io-v1-PredicatePolicy) + + +PredicateArgument represents the arguments to configure predicate functions in scheduler policy configuration. +Only one of its members may be specified + + + + + + + + + + + + + + + + + + +
    FieldDescription
    serviceAffinity [Required]
    +ServiceAffinity +
    + The predicate that provides affinity for pods belonging to a service +It uses a label to identify nodes that belong to the same "group"
    labelsPresence [Required]
    +LabelsPresence +
    + The predicate that checks whether a particular node has a certain label +defined or not, regardless of value
    + + + +## `PredicatePolicy` {#kubescheduler-config-k8s-io-v1-PredicatePolicy} + + + + +**Appears in:** + +- [Policy](#kubescheduler-config-k8s-io-v1-Policy) + + +PredicatePolicy describes a struct of a predicate policy. + + + + + + + + + + + + + + + + + + +
    FieldDescription
    name [Required]
    +string +
    + Identifier of the predicate policy +For a custom predicate, the name can be user-defined +For the Kubernetes provided predicates, the name is the identifier of the pre-defined predicate
    argument [Required]
    +PredicateArgument +
    + Holds the parameters to configure the given predicate
    + + + +## `PriorityArgument` {#kubescheduler-config-k8s-io-v1-PriorityArgument} + + + + +**Appears in:** + +- [PriorityPolicy](#kubescheduler-config-k8s-io-v1-PriorityPolicy) + + +PriorityArgument represents the arguments to configure priority functions in scheduler policy configuration. +Only one of its members may be specified + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    serviceAntiAffinity [Required]
    +ServiceAntiAffinity +
    + The priority function that ensures a good spread (anti-affinity) for pods belonging to a service +It uses a label to identify nodes that belong to the same "group"
    labelPreference [Required]
    +LabelPreference +
    + The priority function that checks whether a particular node has a certain label +defined or not, regardless of value
    requestedToCapacityRatioArguments [Required]
    +RequestedToCapacityRatioArguments +
    + The RequestedToCapacityRatio priority function is parametrized with function shape.
    + + + +## `PriorityPolicy` {#kubescheduler-config-k8s-io-v1-PriorityPolicy} + + + + +**Appears in:** + +- [Policy](#kubescheduler-config-k8s-io-v1-Policy) + + +PriorityPolicy describes a struct of a priority policy. + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    name [Required]
    +string +
    + Identifier of the priority policy +For a custom priority, the name can be user-defined +For the Kubernetes provided priority functions, the name is the identifier of the pre-defined priority function
    weight [Required]
    +int64 +
    + The numeric multiplier for the node scores that the priority function generates +The weight should be non-zero and can be a positive or a negative integer
    argument [Required]
    +PriorityArgument +
    + Holds the parameters to configure the given priority function
    + + + +## `RequestedToCapacityRatioArguments` {#kubescheduler-config-k8s-io-v1-RequestedToCapacityRatioArguments} + + + + +**Appears in:** + +- [PriorityArgument](#kubescheduler-config-k8s-io-v1-PriorityArgument) + + +RequestedToCapacityRatioArguments holds arguments specific to RequestedToCapacityRatio priority function. + + + + + + + + + + + + + + + + + + +
    FieldDescription
    shape [Required]
    +[]UtilizationShapePoint +
    + Array of point defining priority function shape.
    resources [Required]
    +[]ResourceSpec +
    + No description provided. +
    + + + +## `ResourceSpec` {#kubescheduler-config-k8s-io-v1-ResourceSpec} + + + + +**Appears in:** + +- [RequestedToCapacityRatioArguments](#kubescheduler-config-k8s-io-v1-RequestedToCapacityRatioArguments) + + +ResourceSpec represents single resource and weight for bin packing of priority RequestedToCapacityRatioArguments. + + + + + + + + + + + + + + + + + + +
    FieldDescription
    name [Required]
    +string +
    + Name of the resource to be managed by RequestedToCapacityRatio function.
    weight [Required]
    +int64 +
    + Weight of the resource.
    + + + +## `ServiceAffinity` {#kubescheduler-config-k8s-io-v1-ServiceAffinity} + + + + +**Appears in:** + +- [PredicateArgument](#kubescheduler-config-k8s-io-v1-PredicateArgument) + + +ServiceAffinity holds the parameters that are used to configure the corresponding predicate in scheduler policy configuration. + + + + + + + + + + + + + +
    FieldDescription
    labels [Required]
    +[]string +
    + The list of labels that identify node "groups" +All of the labels should match for the node to be considered a fit for hosting the pod
    + + + +## `ServiceAntiAffinity` {#kubescheduler-config-k8s-io-v1-ServiceAntiAffinity} + + + + +**Appears in:** + +- [PriorityArgument](#kubescheduler-config-k8s-io-v1-PriorityArgument) + + +ServiceAntiAffinity holds the parameters that are used to configure the corresponding priority function + + + + + + + + + + + + + +
    FieldDescription
    label [Required]
    +string +
    + Used to identify node "groups"
    + + + +## `UtilizationShapePoint` {#kubescheduler-config-k8s-io-v1-UtilizationShapePoint} + + + + +**Appears in:** + +- [RequestedToCapacityRatioArguments](#kubescheduler-config-k8s-io-v1-RequestedToCapacityRatioArguments) + + +UtilizationShapePoint represents single point of priority function shape. + + + + + + + + + + + + + + + + + + +
    FieldDescription
    utilization [Required]
    +int32 +
    + Utilization (x axis). Valid values are 0 to 100. Fully utilized node maps to 100.
    score [Required]
    +int32 +
    + Score assigned to given utilization (y axis). Valid values are 0 to 10.
    + + + + + +## `ClientConnectionConfiguration` {#ClientConnectionConfiguration} + + + + +**Appears in:** + +- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta1-KubeSchedulerConfiguration) + + +ClientConnectionConfiguration contains details for constructing a client. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    kubeconfig [Required]
    +string +
    + kubeconfig is the path to a KubeConfig file.
    acceptContentTypes [Required]
    +string +
    + acceptContentTypes defines the Accept header sent by clients when connecting to a server, overriding the +default value of 'application/json'. This field will control all connections to the server used by a particular +client.
    contentType [Required]
    +string +
    + contentType is the content type used when sending data to the server from this client.
    qps [Required]
    +float32 +
    + qps controls the number of queries per second allowed for this connection.
    burst [Required]
    +int32 +
    + burst allows extra queries to accumulate when a client is exceeding its rate.
    + +## `DebuggingConfiguration` {#DebuggingConfiguration} + + + + +**Appears in:** + +- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta1-KubeSchedulerConfiguration) + + +DebuggingConfiguration holds configuration for Debugging related features. + + + + + + + + + + + + + + + + + + +
    FieldDescription
    enableProfiling [Required]
    +bool +
    + enableProfiling enables profiling via web interface host:port/debug/pprof/
    enableContentionProfiling [Required]
    +bool +
    + enableContentionProfiling enables lock contention profiling, if +enableProfiling is true.
    + +## `LeaderElectionConfiguration` {#LeaderElectionConfiguration} + + + + +**Appears in:** + +- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta1-KubeSchedulerConfiguration) + + +LeaderElectionConfiguration defines the configuration of leader election +clients for components that can run with leader election enabled. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    leaderElect [Required]
    +bool +
    + leaderElect enables a leader election client to gain leadership +before executing the main loop. Enable this when running replicated +components for high availability.
    leaseDuration [Required]
    +meta/v1.Duration +
    + leaseDuration is the duration that non-leader candidates will wait +after observing a leadership renewal until attempting to acquire +leadership of a led but unrenewed leader slot. This is effectively the +maximum duration that a leader can be stopped before it is replaced +by another candidate. This is only applicable if leader election is +enabled.
    renewDeadline [Required]
    +meta/v1.Duration +
    + renewDeadline is the interval between attempts by the acting master to +renew a leadership slot before it stops leading. This must be less +than or equal to the lease duration. This is only applicable if leader +election is enabled.
    retryPeriod [Required]
    +meta/v1.Duration +
    + retryPeriod is the duration the clients should wait between attempting +acquisition and renewal of a leadership. This is only applicable if +leader election is enabled.
    resourceLock [Required]
    +string +
    + resourceLock indicates the resource object type that will be used to lock +during leader election cycles.
    resourceName [Required]
    +string +
    + resourceName indicates the name of resource object that will be used to lock +during leader election cycles.
    resourceNamespace [Required]
    +string +
    + resourceName indicates the namespace of resource object that will be used to lock +during leader election cycles.
    + +## `LoggingConfiguration` {#LoggingConfiguration} + + + + +**Appears in:** + +- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration) + + +LoggingConfiguration contains logging options +Refer [Logs Options](https://github.com/kubernetes/component-base/blob/master/logs/options.go) for more information. + + + + + + + + + + + + + + + + + + +
    FieldDescription
    format [Required]
    +string +
    + Format Flag specifies the structure of log messages. +default value of format is `text`
    sanitization [Required]
    +bool +
    + [Experimental] When enabled prevents logging of fields tagged as sensitive (passwords, keys, tokens). +Runtime log sanitization may introduce significant computation overhead and therefore should not be enabled in production.`)
    + + + + +## `DefaultPreemptionArgs` {#kubescheduler-config-k8s-io-v1beta1-DefaultPreemptionArgs} + + + + + +DefaultPreemptionArgs holds arguments used to configure the +DefaultPreemption plugin. + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    kubescheduler.config.k8s.io/v1beta1
    kind
    string
    DefaultPreemptionArgs
    minCandidateNodesPercentage [Required]
    +int32 +
    + MinCandidateNodesPercentage is the minimum number of candidates to +shortlist when dry running preemption as a percentage of number of nodes. +Must be in the range [0, 100]. Defaults to 10% of the cluster size if +unspecified.
    minCandidateNodesAbsolute [Required]
    +int32 +
    + MinCandidateNodesAbsolute is the absolute minimum number of candidates to +shortlist. The likely number of candidates enumerated for dry running +preemption is given by the formula: +numCandidates = max(numNodes ∗ minCandidateNodesPercentage, minCandidateNodesAbsolute) +We say "likely" because there are other factors such as PDB violations +that play a role in the number of candidates shortlisted. Must be at least +0 nodes. Defaults to 100 nodes if unspecified.
    + + + +## `InterPodAffinityArgs` {#kubescheduler-config-k8s-io-v1beta1-InterPodAffinityArgs} + + + + + +InterPodAffinityArgs holds arguments used to configure the InterPodAffinity plugin. + + + + + + + + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    kubescheduler.config.k8s.io/v1beta1
    kind
    string
    InterPodAffinityArgs
    hardPodAffinityWeight [Required]
    +int32 +
    + HardPodAffinityWeight is the scoring weight for existing pods with a +matching hard affinity to the incoming pod.
    + + + +## `KubeSchedulerConfiguration` {#kubescheduler-config-k8s-io-v1beta1-KubeSchedulerConfiguration} + + + + + +KubeSchedulerConfiguration configures a scheduler + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    kubescheduler.config.k8s.io/v1beta1
    kind
    string
    KubeSchedulerConfiguration
    parallelism [Required]
    +int32 +
    + Parallelism defines the amount of parallelism in algorithms for scheduling a Pods. Must be greater than 0. Defaults to 16
    leaderElection [Required]
    +LeaderElectionConfiguration +
    + LeaderElection defines the configuration of leader election client.
    clientConnection [Required]
    +ClientConnectionConfiguration +
    + ClientConnection specifies the kubeconfig file and client connection +settings for the proxy server to use when communicating with the apiserver.
    healthzBindAddress [Required]
    +string +
    + HealthzBindAddress is the IP address and port for the health check server to serve on, +defaulting to 0.0.0.0:10251
    metricsBindAddress [Required]
    +string +
    + MetricsBindAddress is the IP address and port for the metrics server to +serve on, defaulting to 0.0.0.0:10251.
    DebuggingConfiguration [Required]
    +DebuggingConfiguration +
    (Members of DebuggingConfiguration are embedded into this type.) + DebuggingConfiguration holds configuration for Debugging related features +TODO: We might wanna make this a substruct like Debugging componentbaseconfigv1alpha1.DebuggingConfiguration
    percentageOfNodesToScore [Required]
    +int32 +
    + PercentageOfNodesToScore is the percentage of all nodes that once found feasible +for running a pod, the scheduler stops its search for more feasible nodes in +the cluster. This helps improve scheduler's performance. Scheduler always tries to find +at least "minFeasibleNodesToFind" feasible nodes no matter what the value of this flag is. +Example: if the cluster size is 500 nodes and the value of this flag is 30, +then scheduler stops finding further feasible nodes once it finds 150 feasible ones. +When the value is 0, default percentage (5%--50% based on the size of the cluster) of the +nodes will be scored.
    podInitialBackoffSeconds [Required]
    +int64 +
    + PodInitialBackoffSeconds is the initial backoff for unschedulable pods. +If specified, it must be greater than 0. If this value is null, the default value (1s) +will be used.
    podMaxBackoffSeconds [Required]
    +int64 +
    + PodMaxBackoffSeconds is the max backoff for unschedulable pods. +If specified, it must be greater than podInitialBackoffSeconds. If this value is null, +the default value (10s) will be used.
    profiles [Required]
    +[]KubeSchedulerProfile +
    + Profiles are scheduling profiles that kube-scheduler supports. Pods can +choose to be scheduled under a particular profile by setting its associated +scheduler name. Pods that don't specify any scheduler name are scheduled +with the "default-scheduler" profile, if present here.
    extenders [Required]
    +[]Extender +
    + Extenders are the list of scheduler extenders, each holding the values of how to communicate +with the extender. These extenders are shared by all scheduler profiles.
    + + + +## `NodeAffinityArgs` {#kubescheduler-config-k8s-io-v1beta1-NodeAffinityArgs} + + + + + +NodeAffinityArgs holds arguments to configure the NodeAffinity plugin. + + + + + + + + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    kubescheduler.config.k8s.io/v1beta1
    kind
    string
    NodeAffinityArgs
    addedAffinity
    +core/v1.NodeAffinity +
    + AddedAffinity is applied to all Pods additionally to the NodeAffinity +specified in the PodSpec. That is, Nodes need to satisfy AddedAffinity +AND .spec.NodeAffinity. AddedAffinity is empty by default (all Nodes +match). +When AddedAffinity is used, some Pods with affinity requirements that match +a specific Node (such as Daemonset Pods) might remain unschedulable.
    + + + +## `NodeLabelArgs` {#kubescheduler-config-k8s-io-v1beta1-NodeLabelArgs} + + + + + +NodeLabelArgs holds arguments used to configure the NodeLabel plugin. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    kubescheduler.config.k8s.io/v1beta1
    kind
    string
    NodeLabelArgs
    presentLabels [Required]
    +[]string +
    + PresentLabels should be present for the node to be considered a fit for hosting the pod
    absentLabels [Required]
    +[]string +
    + AbsentLabels should be absent for the node to be considered a fit for hosting the pod
    presentLabelsPreference [Required]
    +[]string +
    + Nodes that have labels in the list will get a higher score.
    absentLabelsPreference [Required]
    +[]string +
    + Nodes that don't have labels in the list will get a higher score.
    + + + +## `NodeResourcesFitArgs` {#kubescheduler-config-k8s-io-v1beta1-NodeResourcesFitArgs} + + + + + +NodeResourcesFitArgs holds arguments used to configure the NodeResourcesFit plugin. + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    kubescheduler.config.k8s.io/v1beta1
    kind
    string
    NodeResourcesFitArgs
    ignoredResources [Required]
    +[]string +
    + IgnoredResources is the list of resources that NodeResources fit filter +should ignore.
    ignoredResourceGroups [Required]
    +[]string +
    + IgnoredResourceGroups defines the list of resource groups that NodeResources fit filter should ignore. +e.g. if group is ["example.com"], it will ignore all resource names that begin +with "example.com", such as "example.com/aaa" and "example.com/bbb". +A resource group name can't contain '/'.
    + + + +## `NodeResourcesLeastAllocatedArgs` {#kubescheduler-config-k8s-io-v1beta1-NodeResourcesLeastAllocatedArgs} + + + + + +NodeResourcesLeastAllocatedArgs holds arguments used to configure NodeResourcesLeastAllocated plugin. + + + + + + + + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    kubescheduler.config.k8s.io/v1beta1
    kind
    string
    NodeResourcesLeastAllocatedArgs
    resources [Required]
    +[]ResourceSpec +
    + Resources to be managed, if no resource is provided, default resource set with both +the weight of "cpu" and "memory" set to "1" will be applied. +Resource with "0" weight will not accountable for the final score.
    + + + +## `NodeResourcesMostAllocatedArgs` {#kubescheduler-config-k8s-io-v1beta1-NodeResourcesMostAllocatedArgs} + + + + + +NodeResourcesMostAllocatedArgs holds arguments used to configure NodeResourcesMostAllocated plugin. + + + + + + + + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    kubescheduler.config.k8s.io/v1beta1
    kind
    string
    NodeResourcesMostAllocatedArgs
    resources [Required]
    +[]ResourceSpec +
    + Resources to be managed, if no resource is provided, default resource set with both +the weight of "cpu" and "memory" set to "1" will be applied. +Resource with "0" weight will not accountable for the final score.
    + + + +## `PodTopologySpreadArgs` {#kubescheduler-config-k8s-io-v1beta1-PodTopologySpreadArgs} + + + + + +PodTopologySpreadArgs holds arguments used to configure the PodTopologySpread plugin. + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    kubescheduler.config.k8s.io/v1beta1
    kind
    string
    PodTopologySpreadArgs
    defaultConstraints
    +[]core/v1.TopologySpreadConstraint +
    + DefaultConstraints defines topology spread constraints to be applied to +Pods that don't define any in `pod.spec.topologySpreadConstraints`. +`.defaultConstraints[∗].labelSelectors` must be empty, as they are +deduced from the Pod's membership to Services, ReplicationControllers, +ReplicaSets or StatefulSets. +When not empty, .defaultingType must be "List".
    defaultingType
    +PodTopologySpreadConstraintsDefaulting +
    + DefaultingType determines how .defaultConstraints are deduced. Can be one +of "System" or "List". + +- "System": Use kubernetes defined constraints that spread Pods among + Nodes and Zones. +- "List": Use constraints defined in .defaultConstraints. + +Defaults to "List" if feature gate DefaultPodTopologySpread is disabled +and to "System" if enabled.
    + + + +## `RequestedToCapacityRatioArgs` {#kubescheduler-config-k8s-io-v1beta1-RequestedToCapacityRatioArgs} + + + + + +RequestedToCapacityRatioArgs holds arguments used to configure RequestedToCapacityRatio plugin. + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    kubescheduler.config.k8s.io/v1beta1
    kind
    string
    RequestedToCapacityRatioArgs
    shape [Required]
    +[]UtilizationShapePoint +
    + Points defining priority function shape
    resources [Required]
    +[]ResourceSpec +
    + Resources to be managed
    + + + +## `ServiceAffinityArgs` {#kubescheduler-config-k8s-io-v1beta1-ServiceAffinityArgs} + + + + + +ServiceAffinityArgs holds arguments used to configure the ServiceAffinity plugin. + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    kubescheduler.config.k8s.io/v1beta1
    kind
    string
    ServiceAffinityArgs
    affinityLabels [Required]
    +[]string +
    + AffinityLabels are homogeneous for pods that are scheduled to a node. +(i.e. it returns true IFF this pod can be added to this node such that all other pods in +the same service are running on nodes with the exact same values for Labels).
    antiAffinityLabelsPreference [Required]
    +[]string +
    + AntiAffinityLabelsPreference are the labels to consider for service anti affinity scoring.
    + + + +## `VolumeBindingArgs` {#kubescheduler-config-k8s-io-v1beta1-VolumeBindingArgs} + + + + + +VolumeBindingArgs holds arguments used to configure the VolumeBinding plugin. + + + + + + + + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    kubescheduler.config.k8s.io/v1beta1
    kind
    string
    VolumeBindingArgs
    bindTimeoutSeconds [Required]
    +int64 +
    + BindTimeoutSeconds is the timeout in seconds in volume binding operation. +Value must be non-negative integer. The value zero indicates no waiting. +If this value is nil, the default value (600) will be used.
    + + + +## `Extender` {#kubescheduler-config-k8s-io-v1beta1-Extender} + + + + +**Appears in:** + +- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta1-KubeSchedulerConfiguration) + + +Extender holds the parameters used to communicate with the extender. If a verb is unspecified/empty, +it is assumed that the extender chose not to provide that extension. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    urlPrefix [Required]
    +string +
    + URLPrefix at which the extender is available
    filterVerb [Required]
    +string +
    + Verb for the filter call, empty if not supported. This verb is appended to the URLPrefix when issuing the filter call to extender.
    preemptVerb [Required]
    +string +
    + Verb for the preempt call, empty if not supported. This verb is appended to the URLPrefix when issuing the preempt call to extender.
    prioritizeVerb [Required]
    +string +
    + Verb for the prioritize call, empty if not supported. This verb is appended to the URLPrefix when issuing the prioritize call to extender.
    weight [Required]
    +int64 +
    + The numeric multiplier for the node scores that the prioritize call generates. +The weight should be a positive integer
    bindVerb [Required]
    +string +
    + Verb for the bind call, empty if not supported. This verb is appended to the URLPrefix when issuing the bind call to extender. +If this method is implemented by the extender, it is the extender's responsibility to bind the pod to apiserver. Only one extender +can implement this function.
    enableHTTPS [Required]
    +bool +
    + EnableHTTPS specifies whether https should be used to communicate with the extender
    tlsConfig [Required]
    +ExtenderTLSConfig +
    + TLSConfig specifies the transport layer security config
    httpTimeout [Required]
    +meta/v1.Duration +
    + HTTPTimeout specifies the timeout duration for a call to the extender. Filter timeout fails the scheduling of the pod. Prioritize +timeout is ignored, k8s/other extenders priorities are used to select the node.
    nodeCacheCapable [Required]
    +bool +
    + NodeCacheCapable specifies that the extender is capable of caching node information, +so the scheduler should only send minimal information about the eligible nodes +assuming that the extender already cached full details of all nodes in the cluster
    managedResources
    +[]ExtenderManagedResource +
    + ManagedResources is a list of extended resources that are managed by +this extender. +- A pod will be sent to the extender on the Filter, Prioritize and Bind + (if the extender is the binder) phases iff the pod requests at least + one of the extended resources in this list. If empty or unspecified, + all pods will be sent to this extender. +- If IgnoredByScheduler is set to true for a resource, kube-scheduler + will skip checking the resource in predicates.
    ignorable [Required]
    +bool +
    + Ignorable specifies if the extender is ignorable, i.e. scheduling should not +fail when the extender returns an error or is not reachable.
    + + + +## `KubeSchedulerProfile` {#kubescheduler-config-k8s-io-v1beta1-KubeSchedulerProfile} + + + + +**Appears in:** + +- [KubeSchedulerConfiguration](#kubescheduler-config-k8s-io-v1beta1-KubeSchedulerConfiguration) + + +KubeSchedulerProfile is a scheduling profile. + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    schedulerName [Required]
    +string +
    + SchedulerName is the name of the scheduler associated to this profile. +If SchedulerName matches with the pod's "spec.schedulerName", then the pod +is scheduled with this profile.
    plugins [Required]
    +Plugins +
    + Plugins specify the set of plugins that should be enabled or disabled. +Enabled plugins are the ones that should be enabled in addition to the +default plugins. Disabled plugins are any of the default plugins that +should be disabled. +When no enabled or disabled plugin is specified for an extension point, +default plugins for that extension point will be used if there is any. +If a QueueSort plugin is specified, the same QueueSort Plugin and +PluginConfig must be specified for all profiles.
    pluginConfig [Required]
    +[]PluginConfig +
    + PluginConfig is an optional set of custom plugin arguments for each plugin. +Omitting config args for a plugin is equivalent to using the default config +for that plugin.
    + + + +## `Plugin` {#kubescheduler-config-k8s-io-v1beta1-Plugin} + + + + +**Appears in:** + +- [PluginSet](#kubescheduler-config-k8s-io-v1beta1-PluginSet) + + +Plugin specifies a plugin name and its weight when applicable. Weight is used only for Score plugins. + + + + + + + + + + + + + + + + + + +
    FieldDescription
    name [Required]
    +string +
    + Name defines the name of plugin
    weight [Required]
    +int32 +
    + Weight defines the weight of plugin, only used for Score plugins.
    + + + +## `PluginConfig` {#kubescheduler-config-k8s-io-v1beta1-PluginConfig} + + + + +**Appears in:** + +- [KubeSchedulerProfile](#kubescheduler-config-k8s-io-v1beta1-KubeSchedulerProfile) + + +PluginConfig specifies arguments that should be passed to a plugin at the time of initialization. +A plugin that is invoked at multiple extension points is initialized once. Args can have arbitrary structure. +It is up to the plugin to process these Args. + + + + + + + + + + + + + + + + + + +
    FieldDescription
    name [Required]
    +string +
    + Name defines the name of plugin being configured
    args [Required]
    +k8s.io/apimachinery/pkg/runtime.RawExtension +
    + Args defines the arguments passed to the plugins at the time of initialization. Args can have arbitrary structure.
    + + + +## `PluginSet` {#kubescheduler-config-k8s-io-v1beta1-PluginSet} + + + + +**Appears in:** + +- [Plugins](#kubescheduler-config-k8s-io-v1beta1-Plugins) + + +PluginSet specifies enabled and disabled plugins for an extension point. +If an array is empty, missing, or nil, default plugins at that extension point will be used. + + + + + + + + + + + + + + + + + + +
    FieldDescription
    enabled [Required]
    +[]Plugin +
    + Enabled specifies plugins that should be enabled in addition to default plugins. +These are called after default plugins and in the same order specified here.
    disabled [Required]
    +[]Plugin +
    + Disabled specifies default plugins that should be disabled. +When all default plugins need to be disabled, an array containing only one "∗" should be provided.
    + + + +## `Plugins` {#kubescheduler-config-k8s-io-v1beta1-Plugins} + + + + +**Appears in:** + +- [KubeSchedulerProfile](#kubescheduler-config-k8s-io-v1beta1-KubeSchedulerProfile) + + +Plugins include multiple extension points. When specified, the list of plugins for +a particular extension point are the only ones enabled. If an extension point is +omitted from the config, then the default set of plugins is used for that extension point. +Enabled plugins are called in the order specified here, after default plugins. If they need to +be invoked before default plugins, default plugins must be disabled and re-enabled here in desired order. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    queueSort [Required]
    +PluginSet +
    + QueueSort is a list of plugins that should be invoked when sorting pods in the scheduling queue.
    preFilter [Required]
    +PluginSet +
    + PreFilter is a list of plugins that should be invoked at "PreFilter" extension point of the scheduling framework.
    filter [Required]
    +PluginSet +
    + Filter is a list of plugins that should be invoked when filtering out nodes that cannot run the Pod.
    postFilter [Required]
    +PluginSet +
    + PostFilter is a list of plugins that are invoked after filtering phase, no matter whether filtering succeeds or not.
    preScore [Required]
    +PluginSet +
    + PreScore is a list of plugins that are invoked before scoring.
    score [Required]
    +PluginSet +
    + Score is a list of plugins that should be invoked when ranking nodes that have passed the filtering phase.
    reserve [Required]
    +PluginSet +
    + Reserve is a list of plugins invoked when reserving/unreserving resources +after a node is assigned to run the pod.
    permit [Required]
    +PluginSet +
    + Permit is a list of plugins that control binding of a Pod. These plugins can prevent or delay binding of a Pod.
    preBind [Required]
    +PluginSet +
    + PreBind is a list of plugins that should be invoked before a pod is bound.
    bind [Required]
    +PluginSet +
    + Bind is a list of plugins that should be invoked at "Bind" extension point of the scheduling framework. +The scheduler call these plugins in order. Scheduler skips the rest of these plugins as soon as one returns success.
    postBind [Required]
    +PluginSet +
    + PostBind is a list of plugins that should be invoked after a pod is successfully bound.
    + + + +## `PodTopologySpreadConstraintsDefaulting` {#kubescheduler-config-k8s-io-v1beta1-PodTopologySpreadConstraintsDefaulting} + +(Alias of `string`) + + +**Appears in:** + +- [PodTopologySpreadArgs](#kubescheduler-config-k8s-io-v1beta1-PodTopologySpreadArgs) + + +PodTopologySpreadConstraintsDefaulting defines how to set default constraints +for the PodTopologySpread plugin. + + + + + +## `ResourceSpec` {#kubescheduler-config-k8s-io-v1beta1-ResourceSpec} + + + + +**Appears in:** + +- [NodeResourcesLeastAllocatedArgs](#kubescheduler-config-k8s-io-v1beta1-NodeResourcesLeastAllocatedArgs) + +- [NodeResourcesMostAllocatedArgs](#kubescheduler-config-k8s-io-v1beta1-NodeResourcesMostAllocatedArgs) + +- [RequestedToCapacityRatioArgs](#kubescheduler-config-k8s-io-v1beta1-RequestedToCapacityRatioArgs) + + +ResourceSpec represents single resource and weight for bin packing of priority RequestedToCapacityRatioArguments. + + + + + + + + + + + + + + + + + + +
    FieldDescription
    name [Required]
    +string +
    + Name of the resource to be managed by RequestedToCapacityRatio function.
    weight [Required]
    +int64 +
    + Weight of the resource.
    + + + +## `UtilizationShapePoint` {#kubescheduler-config-k8s-io-v1beta1-UtilizationShapePoint} + + + + +**Appears in:** + +- [RequestedToCapacityRatioArgs](#kubescheduler-config-k8s-io-v1beta1-RequestedToCapacityRatioArgs) + + +UtilizationShapePoint represents single point of priority function shape. + + + + + + + + + + + + + + + + + + +
    FieldDescription
    utilization [Required]
    +int32 +
    + Utilization (x axis). Valid values are 0 to 100. Fully utilized node maps to 100.
    score [Required]
    +int32 +
    + Score assigned to given utilization (y axis). Valid values are 0 to 10.
    + + diff --git a/content/en/docs/reference/scheduling/config.md b/content/en/docs/reference/scheduling/config.md index 8d5cc24208..53889a21f3 100644 --- a/content/en/docs/reference/scheduling/config.md +++ b/content/en/docs/reference/scheduling/config.md @@ -19,8 +19,9 @@ Each stage is exposed in a extension point. Plugins provide scheduling behaviors by implementing one or more of these extension points. You can specify scheduling profiles by running `kube-scheduler --config `, -using the component config APIs -([`v1beta1`](https://pkg.go.dev/k8s.io/kube-scheduler@v0.19.0/config/v1beta1?tab=doc#KubeSchedulerConfiguration)). +using the +[KubeSchedulerConfiguration (v1beta1)](/docs/reference/config-api/kube-scheduler-config.v1beta1/) +struct. A minimal configuration looks as follows: @@ -97,6 +98,7 @@ for that extension point. This can also be used to rearrange plugins order, if desired. ### Scheduling plugins + 1. `UnReserve`: This is an informational extension point that is called if a Pod is rejected after being reserved and put on hold by a `Permit` plugin. @@ -245,3 +247,5 @@ only has one pending pods queue. * Read the [kube-scheduler reference](https://kubernetes.io/docs/reference/command-line-tools-reference/kube-scheduler/) * Learn about [scheduling](/docs/concepts/scheduling-eviction/kube-scheduler/) +* Read the [kube-scheduler configuration (v1beta1)](/docs/reference/config-api/kube-scheduler-config.v1beta1/) reference + diff --git a/content/en/docs/reference/scheduling/policies.md b/content/en/docs/reference/scheduling/policies.md index 946150322d..10dd72ba05 100644 --- a/content/en/docs/reference/scheduling/policies.md +++ b/content/en/docs/reference/scheduling/policies.md @@ -17,7 +17,6 @@ You can set a scheduling policy by running and using the [Policy type](https://pkg.go.dev/k8s.io/kube-scheduler@v0.18.0/config/v1?tab=doc#Policy). - ## Predicates @@ -122,5 +121,6 @@ The following *priorities* implement scoring: ## {{% heading "whatsnext" %}} * Learn about [scheduling](/docs/concepts/scheduling-eviction/kube-scheduler/) -* Learn about [kube-scheduler Configuration](/docs/reference/scheduling/config/) +* Learn about [kube-scheduler configuration](/docs/reference/scheduling/config/) +* Read the [kube-scheduler configuration reference (v1beta1)](/docs/reference/config-api/kube-scheduler-config.v1beta1) From cf780b6545dcc2890ace1567ceef0e28fe4e2316 Mon Sep 17 00:00:00 2001 From: seokho-son Date: Fri, 2 Apr 2021 00:18:10 +0900 Subject: [PATCH 090/104] Resolve conflicts on dev-1.20-ko.7 branch --- content/ko/docs/setup/best-practices/certificates.md | 6 +++--- .../ko/docs/setup/production-environment/tools/kubespray.md | 2 +- .../mysql-wordpress-persistent-volume.md | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/content/ko/docs/setup/best-practices/certificates.md b/content/ko/docs/setup/best-practices/certificates.md index 71e16b7675..77665edbe2 100644 --- a/content/ko/docs/setup/best-practices/certificates.md +++ b/content/ko/docs/setup/best-practices/certificates.md @@ -7,7 +7,7 @@ weight: 40 쿠버네티스는 TLS 위에 인증을 위해 PKI 인증서가 필요하다. -만약 [kubeadm](/docs/reference/setup-tools/kubeadm/)으로 쿠버네티스를 설치했다면, 클러스터에 필요한 인증서는 자동으로 생성된다. +만약 [kubeadm](/ko/docs/reference/setup-tools/kubeadm/)으로 쿠버네티스를 설치했다면, 클러스터에 필요한 인증서는 자동으로 생성된다. 또한 더 안전하게 자신이 소유한 인증서를 생성할 수 있다. 이를 테면, 개인키를 API 서버에 저장하지 않으므로 더 안전하게 보관할 수 있다. 이 페이지는 클러스터에 필요한 인증서를 설명한다. @@ -72,7 +72,7 @@ etcd 역시 클라이언트와 피어 간에 상호 TLS 인증을 구현한다. | kube-apiserver-kubelet-client | kubernetes-ca | system:masters | client | | | front-proxy-client | kubernetes-front-proxy-ca | | client | | -[1]: 클러스터에 접속한 다른 IP 또는 DNS 이름([kubeadm](/docs/reference/setup-tools/kubeadm/) 이 사용하는 로드 밸런서 안정 IP 또는 DNS 이름, `kubernetes`, `kubernetes.default`, `kubernetes.default.svc`, +[1]: 클러스터에 접속한 다른 IP 또는 DNS 이름([kubeadm](/ko/docs/reference/setup-tools/kubeadm/) 이 사용하는 로드 밸런서 안정 IP 또는 DNS 이름, `kubernetes`, `kubernetes.default`, `kubernetes.default.svc`, `kubernetes.default.svc.cluster`, `kubernetes.default.svc.cluster.local`) `kind`는 하나 이상의 [x509 키 사용](https://godoc.org/k8s.io/api/certificates/v1beta1#KeyUsage) 종류를 가진다. @@ -97,7 +97,7 @@ kubeadm 사용자만 해당: ### 인증서 파일 경로 -인증서는 권고하는 파일 경로에 존재해야 한다([kubeadm](/docs/reference/setup-tools/kubeadm/)에서 사용되는 것처럼). 경로는 위치에 관계없이 주어진 파라미터를 사용하여 지정되야 한다. +인증서는 권고하는 파일 경로에 존재해야 한다([kubeadm](/ko/docs/reference/setup-tools/kubeadm/)에서 사용되는 것처럼). 경로는 위치에 관계없이 주어진 파라미터를 사용하여 지정해야 한다. | 기본 CN | 권고되는 키 파일 경로 | 권고하는 인증서 파일 경로 | 명령어 | 키 파라미터 | 인증서 파라미터 | |------------------------------|------------------------------|-----------------------------|----------------|------------------------------|-------------------------------------------| diff --git a/content/ko/docs/setup/production-environment/tools/kubespray.md b/content/ko/docs/setup/production-environment/tools/kubespray.md index d838845c61..cb0caf175e 100644 --- a/content/ko/docs/setup/production-environment/tools/kubespray.md +++ b/content/ko/docs/setup/production-environment/tools/kubespray.md @@ -22,7 +22,7 @@ Kubespray는 [Ansible](https://docs.ansible.com/) 플레이북, [인벤토리](h * Flatcar Container Linux by Kinvolk * 지속적인 통합 (CI) 테스트 -클러스터를 설치해 줄 도구로 유스케이스와 가장 잘 맞는 것을 고르고 싶다면, kubespray를 [kubeadm](/docs/reference/setup-tools/kubeadm/), [kops](/ko/docs/setup/production-environment/tools/kops/)와 [비교한 글](https://github.com/kubernetes-sigs/kubespray/blob/master/docs/comparisons.md)을 읽어보자. +클러스터를 설치해 줄 도구로 유스케이스와 가장 잘 맞는 것을 고르고 싶다면, kubespray를 [kubeadm](/ko/docs/reference/setup-tools/kubeadm/), [kops](/ko/docs/setup/production-environment/tools/kops/)와 [비교한 글](https://github.com/kubernetes-sigs/kubespray/blob/master/docs/comparisons.md)을 읽어보자. diff --git a/content/ko/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume.md b/content/ko/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume.md index fd893ca5de..4c5f690d70 100644 --- a/content/ko/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume.md +++ b/content/ko/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume.md @@ -91,7 +91,7 @@ EOF ## MySQL과 WordPress에 필요한 리소스 구성 추가하기 -다음 매니페스트는 MySQL 디플로이먼트 단일 인스턴스를 기술한다. MySQL 컨테이너는 퍼시스턴트볼륨을 /var/lib/mysql에 마운트한다. `MYSQL_ROOT_PASSWORD` 환경변수는 시크릿에서 가져와 데이터베이스 암호로 설정한다. +다음 매니페스트는 MySQL 디플로이먼트 단일 인스턴스를 기술한다. MySQL 컨케이너는 퍼시스턴트볼륨을 /var/lib/mysql에 마운트한다. `MYSQL_ROOT_PASSWORD` 환경 변수는 시크릿에서 가져와 데이터베이스 암호로 설정한다. {{< codenew file="application/wordpress/mysql-deployment.yaml" >}} From d439f4dd1749aa540ce5c478e763cbc975b5378a Mon Sep 17 00:00:00 2001 From: luzg Date: Tue, 30 Mar 2021 17:33:55 +0800 Subject: [PATCH 091/104] [zh] translate task/Install and Set Up kubectl on Linux --- .../optional-kubectl-configs-bash-linux.md | 109 ++++++++ .../docs/tasks/tools/install-kubectl-linux.md | 262 ++++++++++++++++++ 2 files changed, 371 insertions(+) create mode 100644 content/zh/docs/tasks/tools/included/optional-kubectl-configs-bash-linux.md create mode 100644 content/zh/docs/tasks/tools/install-kubectl-linux.md diff --git a/content/zh/docs/tasks/tools/included/optional-kubectl-configs-bash-linux.md b/content/zh/docs/tasks/tools/included/optional-kubectl-configs-bash-linux.md new file mode 100644 index 0000000000..eaee1d9176 --- /dev/null +++ b/content/zh/docs/tasks/tools/included/optional-kubectl-configs-bash-linux.md @@ -0,0 +1,109 @@ +--- +title: "Linux 系统中的 bash 自动补全功能" +description: "Linux 系统中 bash 自动补全功能的一些可选配置。" +headless: true +--- + + + +### 简介 {#introduction} + + +kubectl 的 Bash 补全脚本可以用命令 `kubectl completion bash` 生成。 +在 shell 中导入(Sourcing)补全脚本,将启用 kubectl 自动补全功能。 + +然而,补全脚本依赖于工具 [**bash-completion**](https://github.com/scop/bash-completion), +所以要先安装它(可以用命令 `type _init_completion` 检查 bash-completion 是否已安装)。 + + +### 安装 bash-completion {#install-bash-comletion} + + +很多包管理工具均支持 bash-completion(参见[这里](https://github.com/scop/bash-completion#installation))。 +可以通过 `apt-get install bash-completion` 或 `yum install bash-completion` 等命令来安装它。 + +上述命令将创建文件 `/usr/share/bash-completion/bash_completion`,它是 bash-completion 的主脚本。 +依据包管理工具的实际情况,你需要在 `~/.bashrc` 文件中手工导入此文件。 + +要查看结果,请重新加载你的 shell,并运行命令 `type _init_completion`。 +如果命令执行成功,则设置完成,否则将下面内容添加到文件 `~/.bashrc` 中: + +```bash +source /usr/share/bash-completion/bash_completion +``` + + +重新加载 shell,再输入命令 `type _init_completion` 来验证 bash-completion 的安装状态。 + + +### 启动 kubectl 自动补全功能 {#enable-kubectl-autocompletion} + + +你现在需要确保一点:kubectl 补全脚本已经导入(sourced)到 shell 会话中。 +这里有两种验证方法: + + +- 在文件 `~/.bashrc` 中导入(source)补全脚本: + + ```bash + echo 'source <(kubectl completion bash)' >>~/.bashrc + ``` + + +- 将补全脚本添加到目录 `/etc/bash_completion.d` 中: + + ```bash + kubectl completion bash >/etc/bash_completion.d/kubectl + ``` + + +如果 kubectl 有关联的别名,你可以扩展 shell 补全来适配此别名: + +```bash +echo 'alias k=kubectl' >>~/.bashrc +echo 'complete -F __start_kubectl k' >>~/.bashrc +``` + +{{< note >}} + +bash-completion 负责导入 `/etc/bash_completion.d` 目录中的所有补全脚本。 +{{< /note >}} + + +两种方式的效果相同。重新加载 shell 后,kubectl 自动补全功能即可生效。 diff --git a/content/zh/docs/tasks/tools/install-kubectl-linux.md b/content/zh/docs/tasks/tools/install-kubectl-linux.md new file mode 100644 index 0000000000..8a5f4b8b67 --- /dev/null +++ b/content/zh/docs/tasks/tools/install-kubectl-linux.md @@ -0,0 +1,262 @@ +--- +title: 在 Linux 系统中安装并设置 kubectl +content_type: task +weight: 10 +card: + name: tasks + weight: 20 + title: 在 Linux 系统中安装 kubectl +--- + + +## {{% heading "prerequisites" %}} + + +kubectl 版本和集群版本之间的差异必须在一个小版本号内。 +例如:v1.2 版本的客户端只能与 v1.1、v1.2 和 v1.3 版本的集群一起工作。 +用最新版的 kubectl 有助于避免不可预见的问题。 + + +## 在 Linux 系统中安装 kubectl {#install-kubectl-on-linux} + + +在 Linux 系统中安装 kubectl 有如下几种方法: + +- [{{% heading "prerequisites" %}}](#{{% heading "prerequisites" %}}) +- [在 Linux 系统中安装 kubectl](#install-kubectl-on-linux) + - [用 curl 在 Linux 系统中安装 kubectl](#install-kubectl-binary-with-curl-on-linux) + - [用原生包管理工具安装](#install-using-native-package-management) + - [用其他包管理工具安装](#install-using-other-package-management) + - [作为谷歌云 SDK 的一部分,在 Linux 中安装](#install-on-linux-as-part-of-the-google-cloud-sdk) +- [验证 kubectl 配置](#verify-kubectl-configration) +- [可选的 kubectl 配置](#optional-kubectl-configurations) + - [启用 shell 自动补全功能](#enable-shell-autocompletion) +- [{{% heading "whatsnext" %}}](#{{% heading "whatsnext" %}}) + + +### 用 curl 在 Linux 系统中安装 kubectl {#install-kubectl-binary-with-curl-on-linux} + + +1. 用以下命令下载最新发行版: + + ```bash + curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl" + ``` + + {{< note >}} + +如需下载某个指定的版本,请用指定版本号替换该命令的这一部分: `$(curl -L -s https://dl.k8s.io/release/stable.txt)`。 + +例如,要在 Linux 中下载 {{< param "fullversion" >}} 版本,请输入: + + ```bash + curl -LO https://dl.k8s.io/release/{{< param "fullversion" >}}/bin/linux/amd64/kubectl + ``` + {{< /note >}} + + +1. 验证该可执行文件(可选步骤) + + 下载 kubectl 校验和文件: + + ```bash + curl -LO "https://dl.k8s.io/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl.sha256" + ``` + + + 基于校验和文件,验证 kubectl 的可执行文件: + + ```bash + echo "$( + 验证通过时,输出为: + + ```console + kubectl: OK + ``` + + + 验证失败时,`sha256` 将以非零值退出,并打印如下输出: + + ```bash + kubectl: FAILED + sha256sum: WARNING: 1 computed checksum did NOT match + ``` + + {{< note >}} + + 下载的 kubectl 与校验和文件版本必须相同。 + {{< /note >}} + + +1. 安装 kubectl + + ```bash + sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl + ``` + + {{< note >}} + + 即使你没有目标系统的 root 权限,仍然可以将 kubectl 安装到目录 `~/.local/bin` 中: + + ```bash + mkdir -p ~/.local/bin/kubectl + mv ./kubectl ~/.local/bin/kubectl + # and then add ~/.local/bin/kubectl to $PATH + ``` + + {{< /note >}} + + +1. 执行测试,以保障你安装的版本是最新的: + + ```bash + kubectl version --client + ``` + + +### 用原生包管理工具安装 {#install-using-native-package-management} + +{{< tabs name="kubectl_install" >}} +{{< tab name="Ubuntu、Debian 或 HypriotOS" codelang="bash" >}} +sudo apt-get update && sudo apt-get install -y apt-transport-https gnupg2 curl +curl -s https://packages.cloud.google.com/apt/doc/apt-key.gpg | sudo apt-key add - +echo "deb https://apt.kubernetes.io/ kubernetes-xenial main" | sudo tee -a /etc/apt/sources.list.d/kubernetes.list +sudo apt-get update +sudo apt-get install -y kubectl +{{< /tab >}} + +{{< tab name="CentOS、RHEL 或 Fedora" codelang="bash" >}}cat < /etc/yum.repos.d/kubernetes.repo +[kubernetes] +name=Kubernetes +baseurl=https://packages.cloud.google.com/yum/repos/kubernetes-el7-x86_64 +enabled=1 +gpgcheck=1 +repo_gpgcheck=1 +gpgkey=https://packages.cloud.google.com/yum/doc/yum-key.gpg https://packages.cloud.google.com/yum/doc/rpm-package-key.gpg +EOF +yum install -y kubectl +{{< /tab >}} +{{< /tabs >}} + + +### 用其他包管理工具安装 {#install-using-other-package-management} + +{{< tabs name="other_kubectl_install" >}} +{{% tab name="Snap" %}} + +如果你使用的 Ubuntu 或其他 Linux 发行版,内建支持 [snap](https://snapcraft.io/docs/core/install) 包管理工具, +则可用 [snap](https://snapcraft.io/) 命令安装 kubectl。 + +```shell +snap install kubectl --classic +kubectl version --client +``` + +{{% /tab %}} + +{{% tab name="Homebrew" %}} + +如果你使用 Linux 系统,并且装了 [Homebrew](https://docs.brew.sh/Homebrew-on-Linux) 包管理工具, +则可以使用这种方式[安装](https://docs.brew.sh/Homebrew-on-Linux#install) kubectl。 + +```shell +brew install kubectl +kubectl version --client +``` + +{{% /tab %}} + +{{< /tabs >}} + + +### 作为谷歌云 SDK 的一部分,在 Linux 上安装 {#install-on-linux-as-part-of-the-google-cloud-sdk} + +{{< include "included/install-kubectl-gcloud.md" >}} + + +## 验证 kubectl 配置 {#verify-kubectl-configration} + +{{< include "included/verify-kubectl.md" >}} + +## kubectl 的可选配置 {#optional-kubectl-configurations} + +### 启用 shell 自动补全功能 {#enable-shell-autocompletion} + + +kubectl 为 Bash 和 Zsh 提供自动补全功能,可以减轻许多输入的负担。 + +下面是为 Bash 和 Zsh 设置自动补全功能的操作步骤。 + +{{< tabs name="kubectl_autocompletion" >}} +{{< tab name="Bash" include="included/optional-kubectl-configs-bash-linux.md" />}} +{{< tab name="Zsh" include="included/optional-kubectl-configs-zsh.md" />}} +{{< /tabs >}} + +## {{% heading "whatsnext" %}} + +{{< include "included/kubectl-whats-next.md" >}} From b28250b68f4f0e87b8f77031a8f399af68aa417e Mon Sep 17 00:00:00 2001 From: Qiming Teng Date: Thu, 18 Feb 2021 16:42:27 +0800 Subject: [PATCH 092/104] Add reference for client-authentication v1beta1 This is a reference for client authentication API generated from kubernetes-sigs/reference-docs/genref tool. More specifically, it is generated using the following command: ```shell ./genref -include client-authentication ``` --- content/en/docs/reference/_index.md | 4 + .../access-authn-authz/authentication.md | 9 +- .../client-authentication.v1beta1.md | 252 ++++++++++++++++++ 3 files changed, 264 insertions(+), 1 deletion(-) create mode 100644 content/en/docs/reference/config-api/client-authentication.v1beta1.md diff --git a/content/en/docs/reference/_index.md b/content/en/docs/reference/_index.md index 00adcad7d7..397a200286 100644 --- a/content/en/docs/reference/_index.md +++ b/content/en/docs/reference/_index.md @@ -66,6 +66,10 @@ client libraries: * [kube-proxy configuration (v1alpha1)](/docs/reference/config-api/kube-proxy-config.v1alpha1/) +## Config APIs + +* [Client authentication API (v1beta1)](/docs/reference/config-api/client-authentication.v1beta1/) + ## Design Docs An archive of the design docs for Kubernetes functionality. Good starting points are diff --git a/content/en/docs/reference/access-authn-authz/authentication.md b/content/en/docs/reference/access-authn-authz/authentication.md index 0a830586f0..d09ffa23a2 100644 --- a/content/en/docs/reference/access-authn-authz/authentication.md +++ b/content/en/docs/reference/access-authn-authz/authentication.md @@ -955,7 +955,8 @@ When run from an interactive session, `stdin` is exposed directly to the plugin. [TTY check](https://godoc.org/golang.org/x/crypto/ssh/terminal#IsTerminal) to determine if it's appropriate to prompt a user interactively. -To use bearer token credentials, the plugin returns a token in the status of the `ExecCredential`. +To use bearer token credentials, the plugin returns a token in the status of the +[`ExecCredential`](/docs/reference/config-api/client-authentication.v1beta1/#client-authentication-k8s-io-v1beta1-ExecCredential) ```json { @@ -1005,6 +1006,7 @@ RFC3339 timestamp. Presence or absence of an expiry has the following impact: } } ``` + To enable the exec plugin to obtain cluster-specific information, set `provideClusterInfo` on the `user.exec` field in the [kubeconfig](/docs/concepts/configuration/organize-cluster-access-kubeconfig/). The plugin will then be supplied with an environment variable, `KUBERNETES_EXEC_INFO`. @@ -1029,3 +1031,8 @@ The following `ExecCredential` manifest describes a cluster information sample. } } ``` + +## {{% heading "whatsnext" %}} + +* Read the [client authentication reference (v1beta1)](/docs/reference/config-api/client-authentication.v1beta1/) + diff --git a/content/en/docs/reference/config-api/client-authentication.v1beta1.md b/content/en/docs/reference/config-api/client-authentication.v1beta1.md new file mode 100644 index 0000000000..e78edd23f6 --- /dev/null +++ b/content/en/docs/reference/config-api/client-authentication.v1beta1.md @@ -0,0 +1,252 @@ +--- +title: Client Authentication (v1beta1) +content_type: tool-reference +package: client.authentication.k8s.io/v1beta1 +auto_generated: true +--- + + +## Resource Types + + +- [ExecCredential](#client-authentication-k8s-io-v1beta1-ExecCredential) + + + + +## `ExecCredential` {#client-authentication-k8s-io-v1beta1-ExecCredential} + + + + + +ExecCredential is used by exec-based plugins to communicate credentials to +HTTP transports. + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    client.authentication.k8s.io/v1beta1
    kind
    string
    ExecCredential
    spec [Required]
    +ExecCredentialSpec +
    + Spec holds information passed to the plugin by the transport.
    status
    +ExecCredentialStatus +
    + Status is filled in by the plugin and holds the credentials that the transport +should use to contact the API.
    + + + +## `Cluster` {#client-authentication-k8s-io-v1beta1-Cluster} + + + + +**Appears in:** + +- [ExecCredentialSpec](#client-authentication-k8s-io-v1beta1-ExecCredentialSpec) + + +Cluster contains information to allow an exec plugin to communicate +with the kubernetes cluster being authenticated to. + +To ensure that this struct contains everything someone would need to communicate +with a kubernetes cluster (just like they would via a kubeconfig), the fields +should shadow "k8s.io/client-go/tools/clientcmd/api/v1".Cluster, with the exception +of CertificateAuthority, since CA data will always be passed to the plugin as bytes. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    server [Required]
    +string +
    + Server is the address of the kubernetes cluster (https://hostname:port).
    tls-server-name
    +string +
    + TLSServerName is passed to the server for SNI and is used in the client to +check server certificates against. If ServerName is empty, the hostname +used to contact the server is used.
    insecure-skip-tls-verify
    +bool +
    + InsecureSkipTLSVerify skips the validity check for the server's certificate. +This will make your HTTPS connections insecure.
    certificate-authority-data
    +[]byte +
    + CAData contains PEM-encoded certificate authority certificates. +If empty, system roots should be used.
    proxy-url
    +string +
    + ProxyURL is the URL to the proxy to be used for all requests to this +cluster.
    config
    +k8s.io/apimachinery/pkg/runtime.RawExtension +
    + Config holds additional config data that is specific to the exec +plugin with regards to the cluster being authenticated to. + +This data is sourced from the clientcmd Cluster object's +extensions[client.authentication.k8s.io/exec] field: + +clusters: +- name: my-cluster + cluster: + ... + extensions: + - name: client.authentication.k8s.io/exec # reserved extension name for per cluster exec config + extension: + audience: 06e3fbd18de8 # arbitrary config + +In some environments, the user config may be exactly the same across many clusters +(i.e. call this exec plugin) minus some details that are specific to each cluster +such as the audience. This field allows the per cluster config to be directly +specified with the cluster info. Using this field to store secret data is not +recommended as one of the prime benefits of exec plugins is that no secrets need +to be stored directly in the kubeconfig.
    + + + +## `ExecCredentialSpec` {#client-authentication-k8s-io-v1beta1-ExecCredentialSpec} + + + + +**Appears in:** + +- [ExecCredential](#client-authentication-k8s-io-v1beta1-ExecCredential) + + +ExecCredentialSpec holds request and runtime specific information provided by +the transport. + + + + + + + + + + + + + +
    FieldDescription
    cluster
    +Cluster +
    + Cluster contains information to allow an exec plugin to communicate with the +kubernetes cluster being authenticated to. Note that Cluster is non-nil only +when provideClusterInfo is set to true in the exec provider config (i.e., +ExecConfig.ProvideClusterInfo).
    + + + +## `ExecCredentialStatus` {#client-authentication-k8s-io-v1beta1-ExecCredentialStatus} + + + + +**Appears in:** + +- [ExecCredential](#client-authentication-k8s-io-v1beta1-ExecCredential) + + +ExecCredentialStatus holds credentials for the transport to use. + +Token and ClientKeyData are sensitive fields. This data should only be +transmitted in-memory between client and exec plugin process. Exec plugin +itself should at least be protected via file permissions. + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    expirationTimestamp
    +meta/v1.Time +
    + ExpirationTimestamp indicates a time when the provided credentials expire.
    token [Required]
    +string +
    + Token is a bearer token used by the client for request authentication.
    clientCertificateData [Required]
    +string +
    + PEM-encoded client TLS certificates (including intermediates, if any).
    clientKeyData [Required]
    +string +
    + PEM-encoded private key for the above certificate.
    + + From 94e021ccf639c379b602c40a4d1e497a7d08e1a5 Mon Sep 17 00:00:00 2001 From: Qiming Teng Date: Thu, 18 Feb 2021 15:58:36 +0800 Subject: [PATCH 093/104] Add reference for audit API group This is a reference for audit.k8s.io/v1 API group generated from kubernetes-sigs/reference-docs/genref tool. More specifically, it is generated using the following command: ```shell ./genref -include apiserver-audit ``` --- content/en/docs/reference/_index.md | 18 +- .../config-api/apiserver-audit.v1.md | 620 ++++++++++++++++++ .../tasks/debug-application-cluster/audit.md | 17 +- 3 files changed, 641 insertions(+), 14 deletions(-) create mode 100644 content/en/docs/reference/config-api/apiserver-audit.v1.md diff --git a/content/en/docs/reference/_index.md b/content/en/docs/reference/_index.md index 29dfca82b7..7315d27fbb 100644 --- a/content/en/docs/reference/_index.md +++ b/content/en/docs/reference/_index.md @@ -52,7 +52,9 @@ client libraries: * [kubelet](/docs/reference/command-line-tools-reference/kubelet/) - The primary agent that runs on each node. The kubelet takes a set of PodSpecs and ensures that the described containers are running and healthy. -* [kube-apiserver](/docs/reference/command-line-tools-reference/kube-apiserver/) - REST API that validates and configures data for API objects such as pods, services, replication controllers. +* [kube-apiserver](/docs/reference/command-line-tools-reference/kube-apiserver/) - + REST API that validates and configures data for API objects such as pods, + services, replication controllers. * [kube-controller-manager](/docs/reference/command-line-tools-reference/kube-controller-manager/) - Daemon that embeds the core control loops shipped with Kubernetes. * [kube-proxy](/docs/reference/command-line-tools-reference/kube-proxy/) - Can do simple TCP/UDP stream forwarding or round-robin TCP/UDP forwarding across @@ -64,13 +66,15 @@ client libraries: ## Config APIs +This section hosts the documentation for "unpublished" APIs which are used to +configure kubernetes components or tools. Most of these APIs are not exposed +by the API server in a RESTful way though they are essential for a user or an +operator to use or manage a cluster. + +* [kubelet configuration (v1beta1)](/docs/reference/config-api/kubelet-config.v1beta1/) +* [kube-scheduler configuration (v1beta1)](/docs/reference/config-api/kube-scheduler-config.v1beta1/) * [kube-proxy configuration (v1alpha1)](/docs/reference/config-api/kube-proxy-config.v1alpha1/) -* [kube-scheduler config (v1beta1)](/docs/reference/config-api/kube-scheduler-config.v1beta1/) - - -## Config APIs - -* [kubelet config (v1beta1)](/docs/reference/config-api/kubelet-config.v1beta1/) +* [`audit.k8s.io/v1` API](/docs/reference/config-api/apiserver-audit.v1/) ## Design Docs diff --git a/content/en/docs/reference/config-api/apiserver-audit.v1.md b/content/en/docs/reference/config-api/apiserver-audit.v1.md new file mode 100644 index 0000000000..f0f36c2344 --- /dev/null +++ b/content/en/docs/reference/config-api/apiserver-audit.v1.md @@ -0,0 +1,620 @@ +--- +title: kube-apiserver Audit Configuration (v1) +content_type: tool-reference +package: audit.k8s.io/v1 +auto_generated: true +--- + + +## Resource Types + + +- [Event](#audit-k8s-io-v1-Event) +- [EventList](#audit-k8s-io-v1-EventList) +- [Policy](#audit-k8s-io-v1-Policy) +- [PolicyList](#audit-k8s-io-v1-PolicyList) + + + + +## `Event` {#audit-k8s-io-v1-Event} + + + + +**Appears in:** + +- [EventList](#audit-k8s-io-v1-EventList) + + +Event captures all the information that can be included in an API audit log. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    audit.k8s.io/v1
    kind
    string
    Event
    level [Required]
    +Level +
    + AuditLevel at which event was generated
    auditID [Required]
    +k8s.io/apimachinery/pkg/types.UID +
    + Unique audit ID, generated for each request.
    stage [Required]
    +Stage +
    + Stage of the request handling when this event instance was generated.
    requestURI [Required]
    +string +
    + RequestURI is the request URI as sent by the client to a server.
    verb [Required]
    +string +
    + Verb is the kubernetes verb associated with the request. +For non-resource requests, this is the lower-cased HTTP method.
    user [Required]
    +authentication/v1.UserInfo +
    + Authenticated user information.
    impersonatedUser
    +authentication/v1.UserInfo +
    + Impersonated user information.
    sourceIPs
    +[]string +
    + Source IPs, from where the request originated and intermediate proxies.
    userAgent
    +string +
    + UserAgent records the user agent string reported by the client. +Note that the UserAgent is provided by the client, and must not be trusted.
    objectRef
    +ObjectReference +
    + Object reference this request is targeted at. +Does not apply for List-type requests, or non-resource requests.
    responseStatus
    +meta/v1.Status +
    + The response status, populated even when the ResponseObject is not a Status type. +For successful responses, this will only include the Code and StatusSuccess. +For non-status type error responses, this will be auto-populated with the error Message.
    requestObject
    +k8s.io/apimachinery/pkg/runtime.Unknown +
    + API object from the request, in JSON format. The RequestObject is recorded as-is in the request +(possibly re-encoded as JSON), prior to version conversion, defaulting, admission or +merging. It is an external versioned object type, and may not be a valid object on its own. +Omitted for non-resource requests. Only logged at Request Level and higher.
    responseObject
    +k8s.io/apimachinery/pkg/runtime.Unknown +
    + API object returned in the response, in JSON. The ResponseObject is recorded after conversion +to the external type, and serialized as JSON. Omitted for non-resource requests. Only logged +at Response Level.
    requestReceivedTimestamp
    +meta/v1.MicroTime +
    + Time the request reached the apiserver.
    stageTimestamp
    +meta/v1.MicroTime +
    + Time the request reached current audit stage.
    annotations
    +map[string]string +
    + Annotations is an unstructured key value map stored with an audit event that may be set by +plugins invoked in the request serving chain, including authentication, authorization and +admission plugins. Note that these annotations are for the audit event, and do not correspond +to the metadata.annotations of the submitted object. Keys should uniquely identify the informing +component to avoid name collisions (e.g. podsecuritypolicy.admission.k8s.io/policy). Values +should be short. Annotations are included in the Metadata level.
    + + + +## `EventList` {#audit-k8s-io-v1-EventList} + + + + + +EventList is a list of audit Events. + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    audit.k8s.io/v1
    kind
    string
    EventList
    metadata
    +meta/v1.ListMeta +
    + No description provided. +
    items [Required]
    +[]Event +
    + No description provided. +
    + + + +## `Policy` {#audit-k8s-io-v1-Policy} + + + + +**Appears in:** + +- [PolicyList](#audit-k8s-io-v1-PolicyList) + + +Policy defines the configuration of audit logging, and the rules for how different request +categories are logged. + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    audit.k8s.io/v1
    kind
    string
    Policy
    metadata
    +meta/v1.ObjectMeta +
    + ObjectMeta is included for interoperability with API infrastructure.Refer to the Kubernetes API documentation for the fields of the metadata field.
    rules [Required]
    +[]PolicyRule +
    + Rules specify the audit Level a request should be recorded at. +A request may match multiple rules, in which case the FIRST matching rule is used. +The default audit level is None, but can be overridden by a catch-all rule at the end of the list. +PolicyRules are strictly ordered.
    omitStages
    +[]Stage +
    + OmitStages is a list of stages for which no events are created. Note that this can also +be specified per rule in which case the union of both are omitted.
    + + + +## `PolicyList` {#audit-k8s-io-v1-PolicyList} + + + + + +PolicyList is a list of audit Policies. + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    audit.k8s.io/v1
    kind
    string
    PolicyList
    metadata
    +meta/v1.ListMeta +
    + No description provided. +
    items [Required]
    +[]Policy +
    + No description provided. +
    + + + +## `GroupResources` {#audit-k8s-io-v1-GroupResources} + + + + +**Appears in:** + +- [PolicyRule](#audit-k8s-io-v1-PolicyRule) + + +GroupResources represents resource kinds in an API group. + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    group
    +string +
    + Group is the name of the API group that contains the resources. +The empty string represents the core API group.
    resources
    +[]string +
    + Resources is a list of resources this rule applies to. + +For example: +'pods' matches pods. +'pods/log' matches the log subresource of pods. +'∗' matches all resources and their subresources. +'pods/∗' matches all subresources of pods. +'∗/scale' matches all scale subresources. + +If wildcard is present, the validation rule will ensure resources do not +overlap with each other. + +An empty list implies all resources and subresources in this API groups apply.
    resourceNames
    +[]string +
    + ResourceNames is a list of resource instance names that the policy matches. +Using this field requires Resources to be specified. +An empty list implies that every instance of the resource is matched.
    + + + +## `Level` {#audit-k8s-io-v1-Level} + +(Alias of `string`) + + +**Appears in:** + +- [Event](#audit-k8s-io-v1-Event) + +- [PolicyRule](#audit-k8s-io-v1-PolicyRule) + + +Level defines the amount of information logged during auditing + + + + + +## `ObjectReference` {#audit-k8s-io-v1-ObjectReference} + + + + +**Appears in:** + +- [Event](#audit-k8s-io-v1-Event) + + +ObjectReference contains enough information to let you inspect or modify the referred object. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    resource
    +string +
    + No description provided. +
    namespace
    +string +
    + No description provided. +
    name
    +string +
    + No description provided. +
    uid
    +k8s.io/apimachinery/pkg/types.UID +
    + No description provided. +
    apiGroup
    +string +
    + APIGroup is the name of the API group that contains the referred object. +The empty string represents the core API group.
    apiVersion
    +string +
    + APIVersion is the version of the API group that contains the referred object.
    resourceVersion
    +string +
    + No description provided. +
    subresource
    +string +
    + No description provided. +
    + + + +## `PolicyRule` {#audit-k8s-io-v1-PolicyRule} + + + + +**Appears in:** + +- [Policy](#audit-k8s-io-v1-Policy) + + +PolicyRule maps requests based off metadata to an audit Level. +Requests must match the rules of every field (an intersection of rules). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    level [Required]
    +Level +
    + The Level that requests matching this rule are recorded at.
    users
    +[]string +
    + The users (by authenticated user name) this rule applies to. +An empty list implies every user.
    userGroups
    +[]string +
    + The user groups this rule applies to. A user is considered matching +if it is a member of any of the UserGroups. +An empty list implies every user group.
    verbs
    +[]string +
    + The verbs that match this rule. +An empty list implies every verb.
    resources
    +[]GroupResources +
    + Resources that this rule matches. An empty list implies all kinds in all API groups.
    namespaces
    +[]string +
    + Namespaces that this rule matches. +The empty string "" matches non-namespaced resources. +An empty list implies every namespace.
    nonResourceURLs
    +[]string +
    + NonResourceURLs is a set of URL paths that should be audited. +∗s are allowed, but only as the full, final step in the path. +Examples: + "/metrics" - Log requests for apiserver metrics + "/healthz∗" - Log all health checks
    omitStages
    +[]Stage +
    + OmitStages is a list of stages for which no events are created. Note that this can also +be specified policy wide in which case the union of both are omitted. +An empty list means no restrictions will apply.
    + + + +## `Stage` {#audit-k8s-io-v1-Stage} + +(Alias of `string`) + + +**Appears in:** + +- [Event](#audit-k8s-io-v1-Event) + +- [Policy](#audit-k8s-io-v1-Policy) + +- [PolicyRule](#audit-k8s-io-v1-PolicyRule) + + +Stage defines the stages in request handling that audit events may be generated. + + + + diff --git a/content/en/docs/tasks/debug-application-cluster/audit.md b/content/en/docs/tasks/debug-application-cluster/audit.md index ab4c0c75f7..2f8e1c9875 100644 --- a/content/en/docs/tasks/debug-application-cluster/audit.md +++ b/content/en/docs/tasks/debug-application-cluster/audit.md @@ -46,7 +46,9 @@ Each request can be recorded with an associated _stage_. The defined stages are: - `Panic` - Events generated when a panic occurred. {{< note >}} -Audit events are different from the +The configuration of an +[Audit Event configuration](/docs/reference/config-api/apiserver-audit.v1/#audit-k8s-io-v1-Event) +is different from the [Event](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#event-v1-core) API object. {{< /note >}} @@ -59,7 +61,7 @@ Memory consumption depends on the audit logging configuration. Audit policy defines rules about what events should be recorded and what data they should include. The audit policy object structure is defined in the -[`audit.k8s.io` API group](https://github.com/kubernetes/kubernetes/blob/{{< param "githubbranch" >}}/staging/src/k8s.io/apiserver/pkg/apis/audit/v1/types.go). +[`audit.k8s.io` API group](/docs/reference/config-api/apiserver-audit.v1/#audit-k8s-io-v1-Policy). When an event is processed, it's compared against the list of rules in order. The first matching rule sets the _audit level_ of the event. The defined audit levels are: @@ -95,6 +97,9 @@ If you're crafting your own audit profile, you can use the audit profile for Goo [configure-helper.sh](https://github.com/kubernetes/kubernetes/blob/{{< param "githubbranch" >}}/cluster/gce/gci/configure-helper.sh) script, which generates an audit policy file. You can see most of the audit policy file by looking directly at the script. +You can also refer to the [`Policy` configuration reference](/docs/reference/config-api/apiserver-audit.v1/#audit-k8s-io-v1-Policy) +for details about the fields defined. + ## Audit backends Audit backends persist audit events to an external storage. @@ -104,9 +109,7 @@ Out of the box, the kube-apiserver provides two backends: - Webhook backend, which sends events to an external HTTP API In all cases, audit events follow a structure defined by the Kubernetes API in the -`audit.k8s.io` API group. For Kubernetes {{< param "fullversion" >}}, that -API is at version -[`v1`](https://github.com/kubernetes/kubernetes/blob/{{< param "githubbranch" >}}/staging/src/k8s.io/apiserver/pkg/apis/audit/v1/types.go). +[`audit.k8s.io` API group](/docs/reference/config-api/apiserver-audit.v1/#audit-k8s-io-v1-Event). {{< note >}} In case of patches, request body is a JSON array with patch operations, not a JSON object @@ -174,8 +177,6 @@ and finally configure the `hostPath`: ``` - - ### Webhook backend The webhook audit backend sends audit events to a remote web API, which is assumed to @@ -250,3 +251,5 @@ By default truncate is disabled in both `webhook` and `log`, a cluster administr ## {{% heading "whatsnext" %}} * Learn about [Mutating webhook auditing annotations](/docs/reference/access-authn-authz/extensible-admission-controllers/#mutating-webhook-auditing-annotations). +* Read the [reference for `audit.k8s.io` API group](/docs/reference/config-api/apiserver-audit.v1/). + From 4d20ce5b29146c2167618d9bc35e2903fe8346f0 Mon Sep 17 00:00:00 2001 From: Qiming Teng Date: Thu, 18 Feb 2021 14:14:03 +0800 Subject: [PATCH 094/104] Add reference doc for kube-scheduler policy This is a reference for kube-scheduler policy config generated from kubernetes-sigs/reference-docs/genref tool. More specifically, it is generated using the following command: ``` ./genref --include kube-scheduler-policy-config ``` --- .../manage-resources-containers.md | 16 +- content/en/docs/reference/_index.md | 4 + .../kube-scheduler-policy-config.v1.md | 799 ++++++++++++++++++ .../en/docs/reference/scheduling/policies.md | 8 +- 4 files changed, 809 insertions(+), 18 deletions(-) create mode 100644 content/en/docs/reference/config-api/kube-scheduler-policy-config.v1.md diff --git a/content/en/docs/concepts/configuration/manage-resources-containers.md b/content/en/docs/concepts/configuration/manage-resources-containers.md index 48b6868bde..ee4669641c 100644 --- a/content/en/docs/concepts/configuration/manage-resources-containers.md +++ b/content/en/docs/concepts/configuration/manage-resources-containers.md @@ -518,8 +518,7 @@ Cluster-level extended resources are not tied to nodes. They are usually managed by scheduler extenders, which handle the resource consumption and resource quota. You can specify the extended resources that are handled by scheduler extenders -in [scheduler policy -configuration](https://github.com/kubernetes/kubernetes/blob/release-1.10/pkg/scheduler/api/v1/types.go#L31). +in [scheduler policy configuration](/docs/reference/config-api/kube-scheduler-policy-config.v1/) **Example:** @@ -742,23 +741,14 @@ LastState: map[terminated:map[exitCode:137 reason:OOM Killed startedAt:2015-07-0 You can see that the Container was terminated because of `reason:OOM Killed`, where `OOM` stands for Out Of Memory. - - - - - ## {{% heading "whatsnext" %}} - * Get hands-on experience [assigning Memory resources to Containers and Pods](/docs/tasks/configure-pod-container/assign-memory-resource/). - * Get hands-on experience [assigning CPU resources to Containers and Pods](/docs/tasks/configure-pod-container/assign-cpu-resource/). - * For more details about the difference between requests and limits, see [Resource QoS](https://git.k8s.io/community/contributors/design-proposals/node/resource-qos.md). - * Read the [Container](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#container-v1-core) API reference - * Read the [ResourceRequirements](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#resourcerequirements-v1-core) API reference - * Read about [project quotas](https://xfs.org/docs/xfsdocs-xml-dev/XFS_User_Guide/tmp/en-US/html/xfs-quotas.html) in XFS +* Read more about the [kube-scheduler Policy reference (v1)](/docs/reference/config-api/kube-scheduler-policy-config.v1/) + diff --git a/content/en/docs/reference/_index.md b/content/en/docs/reference/_index.md index 29dfca82b7..e9cd7d9267 100644 --- a/content/en/docs/reference/_index.md +++ b/content/en/docs/reference/_index.md @@ -72,6 +72,10 @@ client libraries: * [kubelet config (v1beta1)](/docs/reference/config-api/kubelet-config.v1beta1/) +## Config APIs + +* [kube-scheduler policy reference (v1)](/docs/reference/config-api/kube-scheduler-policy-config.v1/) + ## Design Docs An archive of the design docs for Kubernetes functionality. Good starting points are diff --git a/content/en/docs/reference/config-api/kube-scheduler-policy-config.v1.md b/content/en/docs/reference/config-api/kube-scheduler-policy-config.v1.md new file mode 100644 index 0000000000..e694f7ecbc --- /dev/null +++ b/content/en/docs/reference/config-api/kube-scheduler-policy-config.v1.md @@ -0,0 +1,799 @@ +--- +title: kube-scheduler Policy Configuration (v1) +content_type: tool-reference +package: kubescheduler.config.k8s.io/v1 +auto_generated: true +--- + + +## Resource Types + + +- [Policy](#kubescheduler-config-k8s-io-v1-Policy) + + + + +## `Policy` {#kubescheduler-config-k8s-io-v1-Policy} + + + + + +Policy describes a struct for a policy resource used in api. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    kubescheduler.config.k8s.io/v1
    kind
    string
    Policy
    predicates [Required]
    +[]PredicatePolicy +
    + Holds the information to configure the fit predicate functions
    priorities [Required]
    +[]PriorityPolicy +
    + Holds the information to configure the priority functions
    extenders [Required]
    +[]LegacyExtender +
    + Holds the information to communicate with the extender(s)
    hardPodAffinitySymmetricWeight [Required]
    +int32 +
    + RequiredDuringScheduling affinity is not symmetric, but there is an implicit PreferredDuringScheduling affinity rule +corresponding to every RequiredDuringScheduling affinity rule. +HardPodAffinitySymmetricWeight represents the weight of implicit PreferredDuringScheduling affinity rule, in the range 1-100.
    alwaysCheckAllPredicates [Required]
    +bool +
    + When AlwaysCheckAllPredicates is set to true, scheduler checks all +the configured predicates even after one or more of them fails. +When the flag is set to false, scheduler skips checking the rest +of the predicates after it finds one predicate that failed.
    + + + +## `ExtenderManagedResource` {#kubescheduler-config-k8s-io-v1-ExtenderManagedResource} + + + + +**Appears in:** + +- [Extender](#kubescheduler-config-k8s-io-v1beta1-Extender) + +- [LegacyExtender](#kubescheduler-config-k8s-io-v1-LegacyExtender) + + +ExtenderManagedResource describes the arguments of extended resources +managed by an extender. + + + + + + + + + + + + + + + + + + +
    FieldDescription
    name [Required]
    +string +
    + Name is the extended resource name.
    ignoredByScheduler [Required]
    +bool +
    + IgnoredByScheduler indicates whether kube-scheduler should ignore this +resource when applying predicates.
    + + + +## `ExtenderTLSConfig` {#kubescheduler-config-k8s-io-v1-ExtenderTLSConfig} + + + + +**Appears in:** + +- [Extender](#kubescheduler-config-k8s-io-v1beta1-Extender) + +- [LegacyExtender](#kubescheduler-config-k8s-io-v1-LegacyExtender) + + +ExtenderTLSConfig contains settings to enable TLS with extender + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    insecure [Required]
    +bool +
    + Server should be accessed without verifying the TLS certificate. For testing only.
    serverName [Required]
    +string +
    + ServerName is passed to the server for SNI and is used in the client to check server +certificates against. If ServerName is empty, the hostname used to contact the +server is used.
    certFile [Required]
    +string +
    + Server requires TLS client certificate authentication
    keyFile [Required]
    +string +
    + Server requires TLS client certificate authentication
    caFile [Required]
    +string +
    + Trusted root certificates for server
    certData [Required]
    +[]byte +
    + CertData holds PEM-encoded bytes (typically read from a client certificate file). +CertData takes precedence over CertFile
    keyData [Required]
    +[]byte +
    + KeyData holds PEM-encoded bytes (typically read from a client certificate key file). +KeyData takes precedence over KeyFile
    caData [Required]
    +[]byte +
    + CAData holds PEM-encoded bytes (typically read from a root certificates bundle). +CAData takes precedence over CAFile
    + + + +## `LabelPreference` {#kubescheduler-config-k8s-io-v1-LabelPreference} + + + + +**Appears in:** + +- [PriorityArgument](#kubescheduler-config-k8s-io-v1-PriorityArgument) + + +LabelPreference holds the parameters that are used to configure the corresponding priority function + + + + + + + + + + + + + + + + + + +
    FieldDescription
    label [Required]
    +string +
    + Used to identify node "groups"
    presence [Required]
    +bool +
    + This is a boolean flag +If true, higher priority is given to nodes that have the label +If false, higher priority is given to nodes that do not have the label
    + + + +## `LabelsPresence` {#kubescheduler-config-k8s-io-v1-LabelsPresence} + + + + +**Appears in:** + +- [PredicateArgument](#kubescheduler-config-k8s-io-v1-PredicateArgument) + + +LabelsPresence holds the parameters that are used to configure the corresponding predicate in scheduler policy configuration. + + + + + + + + + + + + + + + + + + +
    FieldDescription
    labels [Required]
    +[]string +
    + The list of labels that identify node "groups" +All of the labels should be either present (or absent) for the node to be considered a fit for hosting the pod
    presence [Required]
    +bool +
    + The boolean flag that indicates whether the labels should be present or absent from the node
    + + + +## `LegacyExtender` {#kubescheduler-config-k8s-io-v1-LegacyExtender} + + + + +**Appears in:** + +- [Policy](#kubescheduler-config-k8s-io-v1-Policy) + + +LegacyExtender holds the parameters used to communicate with the extender. If a verb is unspecified/empty, +it is assumed that the extender chose not to provide that extension. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    urlPrefix [Required]
    +string +
    + URLPrefix at which the extender is available
    filterVerb [Required]
    +string +
    + Verb for the filter call, empty if not supported. This verb is appended to the URLPrefix when issuing the filter call to extender.
    preemptVerb [Required]
    +string +
    + Verb for the preempt call, empty if not supported. This verb is appended to the URLPrefix when issuing the preempt call to extender.
    prioritizeVerb [Required]
    +string +
    + Verb for the prioritize call, empty if not supported. This verb is appended to the URLPrefix when issuing the prioritize call to extender.
    weight [Required]
    +int64 +
    + The numeric multiplier for the node scores that the prioritize call generates. +The weight should be a positive integer
    bindVerb [Required]
    +string +
    + Verb for the bind call, empty if not supported. This verb is appended to the URLPrefix when issuing the bind call to extender. +If this method is implemented by the extender, it is the extender's responsibility to bind the pod to apiserver. Only one extender +can implement this function.
    enableHttps [Required]
    +bool +
    + EnableHTTPS specifies whether https should be used to communicate with the extender
    tlsConfig [Required]
    +ExtenderTLSConfig +
    + TLSConfig specifies the transport layer security config
    httpTimeout [Required]
    +time.Duration +
    + HTTPTimeout specifies the timeout duration for a call to the extender. Filter timeout fails the scheduling of the pod. Prioritize +timeout is ignored, k8s/other extenders priorities are used to select the node.
    nodeCacheCapable [Required]
    +bool +
    + NodeCacheCapable specifies that the extender is capable of caching node information, +so the scheduler should only send minimal information about the eligible nodes +assuming that the extender already cached full details of all nodes in the cluster
    managedResources
    +[]ExtenderManagedResource +
    + ManagedResources is a list of extended resources that are managed by +this extender. +- A pod will be sent to the extender on the Filter, Prioritize and Bind + (if the extender is the binder) phases iff the pod requests at least + one of the extended resources in this list. If empty or unspecified, + all pods will be sent to this extender. +- If IgnoredByScheduler is set to true for a resource, kube-scheduler + will skip checking the resource in predicates.
    ignorable [Required]
    +bool +
    + Ignorable specifies if the extender is ignorable, i.e. scheduling should not +fail when the extender returns an error or is not reachable.
    + + + +## `PredicateArgument` {#kubescheduler-config-k8s-io-v1-PredicateArgument} + + + + +**Appears in:** + +- [PredicatePolicy](#kubescheduler-config-k8s-io-v1-PredicatePolicy) + + +PredicateArgument represents the arguments to configure predicate functions in scheduler policy configuration. +Only one of its members may be specified + + + + + + + + + + + + + + + + + + +
    FieldDescription
    serviceAffinity [Required]
    +ServiceAffinity +
    + The predicate that provides affinity for pods belonging to a service +It uses a label to identify nodes that belong to the same "group"
    labelsPresence [Required]
    +LabelsPresence +
    + The predicate that checks whether a particular node has a certain label +defined or not, regardless of value
    + + + +## `PredicatePolicy` {#kubescheduler-config-k8s-io-v1-PredicatePolicy} + + + + +**Appears in:** + +- [Policy](#kubescheduler-config-k8s-io-v1-Policy) + + +PredicatePolicy describes a struct of a predicate policy. + + + + + + + + + + + + + + + + + + +
    FieldDescription
    name [Required]
    +string +
    + Identifier of the predicate policy +For a custom predicate, the name can be user-defined +For the Kubernetes provided predicates, the name is the identifier of the pre-defined predicate
    argument [Required]
    +PredicateArgument +
    + Holds the parameters to configure the given predicate
    + + + +## `PriorityArgument` {#kubescheduler-config-k8s-io-v1-PriorityArgument} + + + + +**Appears in:** + +- [PriorityPolicy](#kubescheduler-config-k8s-io-v1-PriorityPolicy) + + +PriorityArgument represents the arguments to configure priority functions in scheduler policy configuration. +Only one of its members may be specified + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    serviceAntiAffinity [Required]
    +ServiceAntiAffinity +
    + The priority function that ensures a good spread (anti-affinity) for pods belonging to a service +It uses a label to identify nodes that belong to the same "group"
    labelPreference [Required]
    +LabelPreference +
    + The priority function that checks whether a particular node has a certain label +defined or not, regardless of value
    requestedToCapacityRatioArguments [Required]
    +RequestedToCapacityRatioArguments +
    + The RequestedToCapacityRatio priority function is parametrized with function shape.
    + + + +## `PriorityPolicy` {#kubescheduler-config-k8s-io-v1-PriorityPolicy} + + + + +**Appears in:** + +- [Policy](#kubescheduler-config-k8s-io-v1-Policy) + + +PriorityPolicy describes a struct of a priority policy. + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    name [Required]
    +string +
    + Identifier of the priority policy +For a custom priority, the name can be user-defined +For the Kubernetes provided priority functions, the name is the identifier of the pre-defined priority function
    weight [Required]
    +int64 +
    + The numeric multiplier for the node scores that the priority function generates +The weight should be non-zero and can be a positive or a negative integer
    argument [Required]
    +PriorityArgument +
    + Holds the parameters to configure the given priority function
    + + + +## `RequestedToCapacityRatioArguments` {#kubescheduler-config-k8s-io-v1-RequestedToCapacityRatioArguments} + + + + +**Appears in:** + +- [PriorityArgument](#kubescheduler-config-k8s-io-v1-PriorityArgument) + + +RequestedToCapacityRatioArguments holds arguments specific to RequestedToCapacityRatio priority function. + + + + + + + + + + + + + + + + + + +
    FieldDescription
    shape [Required]
    +[]UtilizationShapePoint +
    + Array of point defining priority function shape.
    resources [Required]
    +[]ResourceSpec +
    + No description provided. +
    + + + +## `ResourceSpec` {#kubescheduler-config-k8s-io-v1-ResourceSpec} + + + + +**Appears in:** + +- [RequestedToCapacityRatioArguments](#kubescheduler-config-k8s-io-v1-RequestedToCapacityRatioArguments) + + +ResourceSpec represents single resource and weight for bin packing of priority RequestedToCapacityRatioArguments. + + + + + + + + + + + + + + + + + + +
    FieldDescription
    name [Required]
    +string +
    + Name of the resource to be managed by RequestedToCapacityRatio function.
    weight [Required]
    +int64 +
    + Weight of the resource.
    + + + +## `ServiceAffinity` {#kubescheduler-config-k8s-io-v1-ServiceAffinity} + + + + +**Appears in:** + +- [PredicateArgument](#kubescheduler-config-k8s-io-v1-PredicateArgument) + + +ServiceAffinity holds the parameters that are used to configure the corresponding predicate in scheduler policy configuration. + + + + + + + + + + + + + +
    FieldDescription
    labels [Required]
    +[]string +
    + The list of labels that identify node "groups" +All of the labels should match for the node to be considered a fit for hosting the pod
    + + + +## `ServiceAntiAffinity` {#kubescheduler-config-k8s-io-v1-ServiceAntiAffinity} + + + + +**Appears in:** + +- [PriorityArgument](#kubescheduler-config-k8s-io-v1-PriorityArgument) + + +ServiceAntiAffinity holds the parameters that are used to configure the corresponding priority function + + + + + + + + + + + + + +
    FieldDescription
    label [Required]
    +string +
    + Used to identify node "groups"
    + + + +## `UtilizationShapePoint` {#kubescheduler-config-k8s-io-v1-UtilizationShapePoint} + + + + +**Appears in:** + +- [RequestedToCapacityRatioArguments](#kubescheduler-config-k8s-io-v1-RequestedToCapacityRatioArguments) + + +UtilizationShapePoint represents single point of priority function shape. + + + + + + + + + + + + + + + + + + +
    FieldDescription
    utilization [Required]
    +int32 +
    + Utilization (x axis). Valid values are 0 to 100. Fully utilized node maps to 100.
    score [Required]
    +int32 +
    + Score assigned to given utilization (y axis). Valid values are 0 to 10.
    + + diff --git a/content/en/docs/reference/scheduling/policies.md b/content/en/docs/reference/scheduling/policies.md index 10dd72ba05..fc9a740266 100644 --- a/content/en/docs/reference/scheduling/policies.md +++ b/content/en/docs/reference/scheduling/policies.md @@ -14,8 +14,7 @@ respectively. You can set a scheduling policy by running `kube-scheduler --policy-config-file ` or `kube-scheduler --policy-configmap ` -and using the [Policy type](https://pkg.go.dev/k8s.io/kube-scheduler@v0.18.0/config/v1?tab=doc#Policy). - +and using the [Policy type](/docs/reference/config-api/kube-scheduler-policy-config.v1/). @@ -116,11 +115,10 @@ The following *priorities* implement scoring: - `EvenPodsSpreadPriority`: Implements preferred [pod topology spread constraints](/docs/concepts/workloads/pods/pod-topology-spread-constraints/). - - ## {{% heading "whatsnext" %}} * Learn about [scheduling](/docs/concepts/scheduling-eviction/kube-scheduler/) -* Learn about [kube-scheduler configuration](/docs/reference/scheduling/config/) +* Learn about [kube-scheduler Configuration](/docs/reference/scheduling/config/) * Read the [kube-scheduler configuration reference (v1beta1)](/docs/reference/config-api/kube-scheduler-config.v1beta1) +* Read the [kube-scheduler Policy reference (v1)](/docs/reference/config-api/kube-scheduler-policy-config.v1/) From a806f408979e7333d88048b41a7395282bd77c50 Mon Sep 17 00:00:00 2001 From: Ricardo Katz Date: Fri, 2 Apr 2021 01:20:11 -0300 Subject: [PATCH 095/104] Add portuguese translation for networking concepts (#27300) * Add portuguese translation for networking concepts * Correct minor typos * Apply suggestions from code review Co-authored-by: Tim Bannister * Correct typos Co-authored-by: Tim Bannister --- .../cluster-administration/networking.md | 250 ++++++++++++++++++ content/pt/docs/reference/glossary/cni.md | 18 ++ .../glossary/customresourcedefinition.md | 19 ++ 3 files changed, 287 insertions(+) create mode 100644 content/pt/docs/concepts/cluster-administration/networking.md create mode 100644 content/pt/docs/reference/glossary/cni.md create mode 100755 content/pt/docs/reference/glossary/customresourcedefinition.md diff --git a/content/pt/docs/concepts/cluster-administration/networking.md b/content/pt/docs/concepts/cluster-administration/networking.md new file mode 100644 index 0000000000..74abf0ac29 --- /dev/null +++ b/content/pt/docs/concepts/cluster-administration/networking.md @@ -0,0 +1,250 @@ +--- +title: Conectividade do Cluster +content_type: concept +weight: 50 +--- + + +Conectividade é uma parte central do Kubernetes, mas pode ser desafiador +entender exatamente como é o seu funcionamento esperado. Existem 4 problemas +distintos em conectividade que devem ser tratados: + +1. Comunicações contêiner-para-contêiner altamente acopladas: Isso é resolvido + por {{< glossary_tooltip text="Pods" term_id="pod" >}} e comunicações através do `localhost`. +2. Comunicações pod-para-pod: Esse é o foco primário desse documento. +3. Comunicações pod-para-serviço (_service_): Isso é tratado em [Services](/docs/concepts/services-networking/service/). +4. Comunicações Externas-para-serviços: Isso é tratado em [services](/docs/concepts/services-networking/service/). + + + +Kubernetes é basicamente o compartilhamento de máquinas entre aplicações. Tradicionalmente, +compartilhar máquinas requer a garantia de que duas aplicações não tentem utilizar +as mesmas portas. Coordenar a alocação de portas entre múltiplos desenvolvedores é +muito dificil de fazer em escala e expõe os usuários a problemas em nível do cluster e +fora de seu controle. + +A alocação dinâmica de portas traz uma série de complicações para o sistema - toda +aplicação deve obter suas portas através de flags de configuração, os servidores de API +devem saber como inserir números dinämicos de portas nos blocos de configuração, serviços +precisam saber como buscar um ao outro, etc. Ao invés de lidar com isso, o Kubernetes +faz de uma maneira diferente. + +## O modelo de conectividade e rede do Kubernetes + +Todo `Pod` obtém seu próprio endereço IP. Isso significa que vocë não precisa +criar links explícitos entre os `Pods` e vocë quase nunca terá que lidar com o +mapeamento de portas de contêineres para portas do host. Isso cria um modelo simples, +retro-compatível onde os `Pods` podem ser tratados muito mais como VMs ou hosts +físicos da perspectiva de alocação de portas, nomes, descobrimento de serviços +(_service discovery_), balanceamento de carga, configuração de aplicações e migrações. + +O Kubernetes impõe os seguintes requisitos fundamentais para qualquer implementação de +rede (exceto qualquer política de segmentação intencional): + * pods em um nó podem se comunicar com todos os pods em todos os nós sem usar _NAT_. + * agentes em um nó (por exemplo o kubelet ou um serviço local) podem se comunicar com + todos os Pods naquele nó. + +Nota: Para as plataformas que suportam `Pods` executando na rede do host (como o Linux): + + * pods alocados na rede do host de um nó podem se comunicar com todos os pods + em todos os nós sem _NAT_. + +Esse modelo não só é menos complexo, mas é principalmente compatível com o +desejo do Kubernetes de permitir a portabilidade com baixo esforço de aplicações +de VMs para contêineres. Se a sua aplicação executava anteriormente em uma VM, sua VM +possuía um IP e podia se comunicar com outras VMs no seu projeto. Esse é o mesmo +modelo básico. + +Os endereços de IP no Kubernetes existem no escopo do `Pod` - contêineres em um `Pod` +compartilham o mesmo _network namespace_ - incluíndo seu endereço de IP e MAC. +Isso significa que contêineres que compõem um `Pod` podem se comunicar entre eles +através do endereço `localhost` e respectivas portas. Isso também significa que +contêineres em um mesmo `Pod` devem coordenar a alocação e uso de portas, o que não +difere do modelo de processos rodando dentro de uma mesma VM. Isso é chamado de +modelo "IP-por-pod". + +Como isso é implementado é um detalhe do agente de execução de contêiner em uso. + +É possível solicitar uma porta no nó que será encaminhada para seu `Pod` (chamado +de _portas do host_), mas isso é uma operação muito específica. Como esse encaminhamento +é implementado é um detalhe do agente de execução do contêiner. O `Pod` mesmo +desconhece a existência ou não de portas do host. + +## Como implementar o modelo de conectividade do Kubernetes + +Existe um número de formas de implementar esse modelo de conectividade. Esse +documento não é um estudo exaustivo desses vários métodos, mas pode servir como +uma introdução de várias tecnologias e serve como um ponto de início. + +A conectividade no Kubernetes é fornecida através de plugins de +{{< glossary_tooltip text="CNIs" term_id="cni" >}} + +As seguintes opções estão organizadas alfabeticamente e não implicam preferência por +qualquer solução. + +{{% thirdparty-content %}} + +### Antrea + +O projeto [Antrea](https://github.com/vmware-tanzu/antrea) é uma solução de +conectividade para Kubernetes que pretende ser nativa. Ela utiliza o Open vSwitch +na camada de conectividade de dados. O Open vSwitch é um switch virtual de alta +performance e programável que suporta Linux e Windows. O Open vSwitch permite +ao Antrea implementar políticas de rede do Kubernetes (_NetworkPolicies_) de +uma forma muito performática e eficiente. + +Graças à característica programável do Open vSwitch, o Antrea consegue implementar +uma série de funcionalidades de rede e segurança. + +### AWS VPC CNI para Kubernetes + +O [AWS VPC CNI](https://github.com/aws/amazon-vpc-cni-k8s) oferece conectividade +com o AWS Virtual Private Cloud (VPC) para clusters Kubernetes. Esse plugin oferece +alta performance e disponibilidade e baixa latência. Adicionalmente, usuários podem +aplicar as melhores práticas de conectividade e segurança existentes no AWS VPC +para a construção de clusters Kubernetes. Isso inclui possibilidade de usar o +_VPC flow logs_, políticas de roteamento da VPC e grupos de segurança para isolamento +de tráfego. + +O uso desse plugin permite aos Pods no Kubernetes ter o mesmo endereço de IP dentro do +pod como se eles estivessem dentro da rede do VPC. O CNI (Container Network Interface) +aloca um _Elastic Networking Interface_ (ENI) para cada nó do Kubernetes e usa uma +faixa de endereços IP secundário de cada ENI para os Pods no nó. O CNI inclui +controles para pré alocação dos ENIs e endereços IP para um início mais rápido dos +pods e permite clusters com até 2,000 nós. + +Adicionalmente, esse CNI pode ser utilizado junto com o [Calico](https://docs.aws.amazon.com/eks/latest/userguide/calico.html) +para a criação de políticas de rede (_NetworkPolicies_). O projeto AWS VPC CNI +tem código fonte aberto com a [documentação no Github](https://github.com/aws/amazon-vpc-cni-k8s). + +### Azure CNI para o Kubernetes +[Azure CNI](https://docs.microsoft.com/en-us/azure/virtual-network/container-networking-overview) é um +plugin de [código fonte aberto](https://github.com/Azure/azure-container-networking/blob/master/docs/cni.md) +que integra os Pods do Kubernetes com uma rede virtual da Azure (também conhecida como VNet) +provendo performance de rede similar à de máquinas virtuais no ambiente. Os Pods +podem se comunicar com outras VNets e com ambientes _on-premises_ com o uso de +funcionalidades da Azure, e também podem ter clientes com origem dessas redes. +Os Pods podem acessar serviços da Azure, como armazenamento e SQL, que são +protegidos por _Service Endpoints_ e _Private Link_. Você pode utilizar as políticas +de segurança e roteamento para filtrar o tráfico do Pod. O plugin associa IPs da VNet +para os Pods utilizando um pool de IPs secundário pré-configurado na interface de rede +do nó Kubernetes. + +O Azure CNI está disponível nativamente no [Azure Kubernetes Service (AKS)](https://docs.microsoft.com/en-us/azure/aks/configure-azure-cni). + +### Calico + +[Calico](https://docs.projectcalico.org/) é uma solução de conectividade e +segurança para contêineres, máquinas virtuais e serviços nativos em hosts. O +Calico suporta múltiplas camadas de conectividade/dados, como por exemplo: +uma camada Linux eBPF nativa, uma camada de conectividade baseada em conceitos +padrão do Linux e uma camada baseada no HNS do Windows. O calico provê uma +camada completa de conectividade e rede, mas também pode ser usado em conjunto com +[CNIs de provedores de nuvem](https://docs.projectcalico.org/networking/determine-best-networking#calico-compatible-cni-plugins-and-cloud-provider-integrations) +para permitir a criação de políticas de rede. + +### Cilium + +[Cilium](https://github.com/cilium/cilium) é um software de código fonte aberto +para prover conectividade e segurança entre contêineres de aplicação. O Cilium +pode lidar com tráfego na camada de aplicação (ex. HTTP) e pode forçar políticas +de rede nas camadas L3-L7 usando um modelo de segurança baseado em identidade e +desacoplado do endereçamento de redes, podendo inclusive ser utilizado com outros +plugins CNI. + +### Flannel + +[Flannel](https://github.com/coreos/flannel#flannel) é uma camada muito simples +de conectividade que satisfaz os requisitos do Kubernetes. Muitas pessoas +reportaram sucesso em utilizar o Flannel com o Kubernetes. + +### Google Compute Engine (GCE) + +Para os scripts de configuração do Google Compute Engine, [roteamento +avançado](https://cloud.google.com/vpc/docs/routes) é usado para associar +para cada VM uma sub-rede (o padrão é `/24` - 254 IPs). Qualquer tráfico direcionado +para aquela sub-rede será roteado diretamente para a VM pela rede do GCE. Isso é +adicional ao IP principal associado à VM, que é mascarado para o acesso à Internet. +Uma _brige_ Linux (chamada `cbr0`) é configurada para existir naquela sub-rede, e é +configurada no docker através da opção `--bridge`. + +O Docker é iniciado com: + + +```shell +DOCKER_OPTS="--bridge=cbr0 --iptables=false --ip-masq=false" +``` + +Essa _bridge_ é criada pelo Kubelet (controlada pela opção `--network-plugin=kubenet`) +de acordo com a informação `.spec.podCIDR` do Nó. + +O Docker irá agora alocar IPs do bloco `cbr-cidr`. Contêineres podem alcançar +outros contêineres e nós através da interface `cbr0`. Esses IPs são todos roteáveis +dentro da rede do projeto do GCE. + +O GCE mesmo não sabe nada sobre esses IPs, então não irá mascará-los quando tentarem +se comunicar com a internet. Para permitir isso uma regra de IPTables é utilizada para +mascarar o tráfego para IPs fora da rede do projeto do GCE (no exemplo abaixo, 10.0.0.0/8): + +```shell +iptables -t nat -A POSTROUTING ! -d 10.0.0.0/8 -o eth0 -j MASQUERADE +``` + +Por fim, o encaminhamento de IP deve ser habilitado no Kernel de forma a processar +os pacotes vindos dos contêineres: + +```shell +sysctl net.ipv4.ip_forward=1 +``` + +O resultado disso tudo é que `Pods` agora podem alcançar outros `Pods` e podem também +se comunicar com a Internet. + +### Kube-router + +[Kube-router](https://github.com/cloudnativelabs/kube-router) é uma solução construída +que visa prover alta performance e simplicidade operacional. Kube-router provê um +proxy de serviços baseado no [LVS/IPVS](https://www.linuxvirtualserver.org/software/ipvs.html), +uma solução de comunicação pod-para-pod baseada em encaminhamento de pacotes Linux e sem camadas +adicionais, e funcionalidade de políticas de redes baseadas no IPTables/IPSet. + +### Redes L2 e bridges Linux + +Se você tem uma rede L2 "burra", como um switch em um ambiente "bare-metal", +você deve conseguir fazer algo similar ao ambiente GCE explicado acima. +Note que essas instruções foram testadas casualmente - parece funcionar, mas +não foi propriamente testado. Se você conseguir usar essa técnica e aperfeiçoar +o processo, por favor nos avise!! + +Siga a parte _"With Linux Bridge devices"_ desse +[tutorial super bacana](https://blog.oddbit.com/2014/08/11/four-ways-to-connect-a-docker/) do +Lars Kellogg-Stedman. + +### Multus (Plugin multi redes) {#multus} + +[Multus](https://github.com/Intel-Corp/multus-cni) é um plugin Multi CNI para +suportar a funcionalidade multi redes do Kubernetes usando objetos baseados em {{< glossary_tooltip text="CRDs" term_id="CustomResourceDefinition" >}}. + +Multus suporta todos os [plugins referência](https://github.com/containernetworking/plugins) (ex. [Flannel](https://github.com/containernetworking/plugins/tree/master/plugins/meta/flannel), +[DHCP](https://github.com/containernetworking/plugins/tree/master/plugins/ipam/dhcp), +[Macvlan](https://github.com/containernetworking/plugins/tree/master/plugins/main/macvlan)) +que implementam a especificação de CNI e plugins de terceiros +(ex. [Calico](https://github.com/projectcalico/cni-plugin), [Weave](https://github.com/weaveworks/weave), +[Cilium](https://github.com/cilium/cilium), [Contiv](https://github.com/contiv/netplugin)). +Adicionalmente, Multus suporta cargas de trabalho no Kubernetes que necessitem de funcionalidades como +[SRIOV](https://github.com/hustcat/sriov-cni), [DPDK](https://github.com/Intel-Corp/sriov-cni), +[OVS-DPDK & VPP](https://github.com/intel/vhost-user-net-plugin). + +### OVN (Open Virtual Networking) + +OVN é uma solução de virtualização de redes de código aberto desenvolvido pela +comunidade Open vSwitch. Permite a criação de switches lógicos, roteadores lógicos, +listas de acesso, balanceadores de carga e mais, para construir diferences topologias +de redes virtuais. Esse projeto possui um plugin específico para o Kubernetes e a +documentação em [ovn-kubernetes](https://github.com/openvswitch/ovn-kubernetes). + +## {{% heading "whatsnext" %}} + +Design inicial do modelo de conectividade do Kubernetes e alguns planos futuros +estão descritos com maiores detalhes no +[documento de design de redes](https://git.k8s.io/community/contributors/design-proposals/network/networking.md). diff --git a/content/pt/docs/reference/glossary/cni.md b/content/pt/docs/reference/glossary/cni.md new file mode 100644 index 0000000000..6cb909f962 --- /dev/null +++ b/content/pt/docs/reference/glossary/cni.md @@ -0,0 +1,18 @@ +--- +title: Container network interface (CNI) +id: cni +date: 2018-05-25 +full_link: /docs/concepts/extend-kubernetes/compute-storage-net/network-plugins/#cni +short_description: > + Plugins Container network interface (CNI) são um tipo de plugin de Rede em conformidade com a especificação appc/CNI. + + +aka: +tags: +- networking +--- + Plugins Container network interface (CNI) são um tipo de plugin de Rede em conformidade com a especificação appc/CNI. + + +* Para informações sobre Kubernetes e CNI, veja [aqui](/docs/concepts/extend-kubernetes/compute-storage-net/network-plugins/#cni). +* Para informações sobre Kubernetes e CNI, veja ["Plugins de rede"](/docs/concepts/extend-kubernetes/compute-storage-net/network-plugins/#cni). diff --git a/content/pt/docs/reference/glossary/customresourcedefinition.md b/content/pt/docs/reference/glossary/customresourcedefinition.md new file mode 100755 index 0000000000..7de24c036b --- /dev/null +++ b/content/pt/docs/reference/glossary/customresourcedefinition.md @@ -0,0 +1,19 @@ +--- +title: CustomResourceDefinition +id: CustomResourceDefinition +date: 2018-04-12 +full_link: /docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/ +short_description: > + Código customizado que define um recurso a ser adicionado ao seu servidor de API Kubernetes sem a necessidade de construir um servidor customizado. + +aka: +tags: +- fundamental +- operation +- extension +--- + Código customizado que define um recurso a ser adicionado ao seu servidor de API Kubernetes sem a necessidade de construir um servidor customizado. + + + +CustomResourceDefinitions permitem você extender a API do Kubernetes para seu ambiente caso as APIs atuais não cumpram com seus requisitos. From d2bf43be4da658f24fdb2bf451bb865b89a8df72 Mon Sep 17 00:00:00 2001 From: Rey Lejano Date: Fri, 26 Mar 2021 23:10:10 -0700 Subject: [PATCH 096/104] Generate reference doc for 1.21.0-rc.0 tag empty commit to rebuild netlify preview --- .../generated/kubectl/kubectl-commands.html | 738 +- .../reference/generated/kubectl/navData.js | 2 +- .../generated/kubernetes-api/v1.21/index.html | 52412 ++++++++++++++++ .../kubernetes-api/v1.21/js/navData.js | 1 + 4 files changed, 52874 insertions(+), 279 deletions(-) create mode 100644 static/docs/reference/generated/kubernetes-api/v1.21/index.html create mode 100644 static/docs/reference/generated/kubernetes-api/v1.21/js/navData.js diff --git a/static/docs/reference/generated/kubectl/kubectl-commands.html b/static/docs/reference/generated/kubectl/kubectl-commands.html index 050188950d..6d1b082c61 100644 --- a/static/docs/reference/generated/kubectl/kubectl-commands.html +++ b/static/docs/reference/generated/kubectl/kubectl-commands.html @@ -12,7 +12,7 @@ - +
    • example

    GETTING STARTED

    @@ -130,6 +130,12 @@ inspect them.

    Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) +show-managed-fields + +false +If true, keep the managedFields when printing objects in JSON or YAML format. + + template @@ -250,6 +256,12 @@ inspect them.

    If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. +show-managed-fields + +false +If true, keep the managedFields when printing objects in JSON or YAML format. + + template @@ -339,6 +351,12 @@ inspect them.

    Service accounts to bind to the clusterrole, in the format <namespace>:<name> +show-managed-fields + +false +If true, keep the managedFields when printing objects in JSON or YAML format. + + template @@ -439,12 +457,6 @@ inspect them.

    Specify a key and literal value to insert in configmap (i.e. mykey=somevalue) -generator - -configmap/v1 -The name of the API generator to use. - - output o @@ -457,6 +469,12 @@ inspect them.

    If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. +show-managed-fields + +false +If true, keep the managedFields when printing objects in JSON or YAML format. + + template @@ -545,6 +563,12 @@ inspect them.

    A schedule in the Cron format the job should be run with. +show-managed-fields + +false +If true, keep the managedFields when printing objects in JSON or YAML format. + + template @@ -649,6 +673,12 @@ inspect them.

    If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. +show-managed-fields + +false +If true, keep the managedFields when printing objects in JSON or YAML format. + + template @@ -784,6 +814,12 @@ inspect them.

    If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. +show-managed-fields + +false +If true, keep the managedFields when printing objects in JSON or YAML format. + + template @@ -871,6 +907,12 @@ inspect them.

    If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. +show-managed-fields + +false +If true, keep the managedFields when printing objects in JSON or YAML format. + + template @@ -924,12 +966,6 @@ inspect them.

    Name of the manager used to track field ownership. -generator - -namespace/v1 -The name of the API generator to use. - - output o @@ -942,6 +978,12 @@ inspect them.

    If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. +show-managed-fields + +false +If true, keep the managedFields when printing objects in JSON or YAML format. + + template @@ -1000,12 +1042,6 @@ inspect them.

    Name of the manager used to track field ownership. -generator - -poddisruptionbudget/v1beta1/v2 -The name of the API generator to use. - - max-unavailable @@ -1036,6 +1072,12 @@ inspect them.

    A label selector to use for this budget. Only equality-based selector requirements are supported. +show-managed-fields + +false +If true, keep the managedFields when printing objects in JSON or YAML format. + + template @@ -1129,6 +1171,12 @@ inspect them.

    If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. +show-managed-fields + +false +If true, keep the managedFields when printing objects in JSON or YAML format. + + template @@ -1217,6 +1265,12 @@ inspect them.

    A comma-delimited set of quota scopes that must all match each object tracked by the quota. +show-managed-fields + +false +If true, keep the managedFields when printing objects in JSON or YAML format. + + template @@ -1309,6 +1363,12 @@ inspect them.

    If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. +show-managed-fields + +false +If true, keep the managedFields when printing objects in JSON or YAML format. + + template @@ -1404,6 +1464,12 @@ inspect them.

    Service accounts to bind to the role, in the format <namespace>:<name> +show-managed-fields + +false +If true, keep the managedFields when printing objects in JSON or YAML format. + + template @@ -1429,6 +1495,11 @@ inspect them.

    kubectl create secret docker-registry my-secret --docker-server=DOCKER_REGISTRY_SERVER --docker-username=DOCKER_USER --docker-password=DOCKER_PASSWORD --docker-email=DOCKER_EMAIL
     
    +
    +

    Create a new secret named my-secret from ~/.docker/config.json

    +
    +
    kubectl create secret docker-registry my-secret --from-file=.dockerconfigjson=path/to/.docker/config.json
    +

    Create a new secret for use with Docker registries.

    Dockercfg secrets are used to authenticate against Docker registries.

    When using the Docker command line to push images, you can authenticate to a given registry by running: @@ -1438,7 +1509,7 @@ inspect them.

    nodes to pull images on your behalf, they have to have the credentials. You can provide this information by creating a dockercfg secret and attaching it to your service account.

    Usage

    -

    $ kubectl create docker-registry NAME --docker-username=user --docker-password=password --docker-email=email [--docker-server=string] [--from-literal=key1=value1] [--dry-run=server|client|none]

    +

    $ kubectl create docker-registry NAME --docker-username=user --docker-password=password --docker-email=email [--docker-server=string] [--from-file=[key=]source] [--dry-run=server|client|none]

    Flags

    @@ -1505,12 +1576,6 @@ inspect them.

    - - - - - - @@ -1523,6 +1588,12 @@ inspect them.

    + + + + + + @@ -1623,12 +1694,6 @@ inspect them.

    - - - - - - @@ -1641,6 +1706,12 @@ inspect them.

    + + + + + + @@ -1713,12 +1784,6 @@ inspect them.

    - - - - - - @@ -1737,6 +1802,12 @@ inspect them.

    + + + + + + @@ -1818,6 +1889,12 @@ inspect them.

    + + + + + + @@ -1896,6 +1973,12 @@ inspect them.

    + + + + + + @@ -1967,6 +2050,12 @@ inspect them.

    + + + + + + @@ -2044,6 +2133,12 @@ inspect them.

    + + + + + + @@ -2103,12 +2198,6 @@ inspect them.

    - - - - - - @@ -2121,6 +2210,12 @@ inspect them.

    + + + + + + @@ -2312,6 +2407,12 @@ inspect them.

    + + + + + + @@ -2471,12 +2572,6 @@ inspect them.

    - - - - - - @@ -2556,7 +2651,7 @@ inspect them.

    - + @@ -2573,12 +2668,6 @@ inspect them.

    - - - - - - @@ -2603,30 +2692,18 @@ inspect them.

    - - - - - - - - - - - - - - - - - - + + + + + + @@ -2839,6 +2916,12 @@ inspect them.

    + + + + + + @@ -3183,6 +3266,12 @@ viewing your workloads in a Kubernetes cluster.

    + + + + + + @@ -3281,6 +3370,12 @@ viewing your workloads in a Kubernetes cluster.

    + + + + + + @@ -3356,6 +3451,12 @@ viewing your workloads in a Kubernetes cluster.

    + + + + + + @@ -3568,6 +3669,12 @@ viewing your workloads in a Kubernetes cluster.

    + + + + + + @@ -3687,6 +3794,12 @@ viewing your workloads in a Kubernetes cluster.

    + + + + + + @@ -3796,7 +3909,7 @@ viewing your workloads in a Kubernetes cluster.

    - + @@ -4015,6 +4128,12 @@ viewing your workloads in a Kubernetes cluster.

    + + + + + + @@ -4037,25 +4156,96 @@ viewing your workloads in a Kubernetes cluster.


    kustomize

    -

    Use the current working directory

    +

    Build the current working directory

    -
    kubectl%20kustomize%20.
    +
    kubectl kustomize
     
    -

    Use some shared configuration directory

    +

    Build some shared configuration directory

    -
    kubectl kustomize /home/configuration/production
    +
    kubectl kustomize /home/config/production
     
    -

    Use a URL

    +

    Build from github

    -
    kubectl kustomize github.com/kubernetes-sigs/kustomize.git/examples/helloWorld?ref=v1.0.6
    +
    kubectl kustomize https://github.com/kubernetes-sigs/kustomize.git/examples/helloWorld?ref=v1.0.6
     
    -

    Print a set of API resources generated from instructions in a kustomization.yaml file.

    -

    The argument must be the path to the directory containing the file, or a git repository URL with a path suffix specifying same with respect to the repository root.

    -

    kubectl kustomize somedir

    +

    Build a set of KRM resources using a 'kustomization.yaml' file. The DIR argument must be a path to a directory containing 'kustomization.yaml', or a git repository URL with a path suffix specifying same with respect to the repository root. If DIR is omitted, '.' is assumed.

    Usage

    -

    $ kubectl kustomize <dir>

    +

    $ kubectl kustomize DIR

    +

    Flags

    +
    Key files can be specified using their file path, in which case a default name will be given to them, or optionally with a name and file path, in which case the given name will be used. Specifying a directory will iterate each named file in the directory that is a valid secret key.
    generatorsecret-for-docker-registry/v1The name of the API generator to use.
    output o If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.
    show-managed-fieldsfalseIf true, keep the managedFields when printing objects in JSON or YAML format.
    template Specify a key and literal value to insert in secret (i.e. mykey=somevalue)
    generatorsecret/v1The name of the API generator to use.
    output o If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.
    show-managed-fieldsfalseIf true, keep the managedFields when printing objects in JSON or YAML format.
    template Name of the manager used to track field ownership.
    generatorsecret-for-tls/v1The name of the API generator to use.
    key If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.
    show-managed-fieldsfalseIf true, keep the managedFields when printing objects in JSON or YAML format.
    template If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.
    show-managed-fieldsfalseIf true, keep the managedFields when printing objects in JSON or YAML format.
    tcp [] If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.
    show-managed-fieldsfalseIf true, keep the managedFields when printing objects in JSON or YAML format.
    tcp [] If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.
    show-managed-fieldsfalseIf true, keep the managedFields when printing objects in JSON or YAML format.
    tcp [] If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.
    show-managed-fieldsfalseIf true, keep the managedFields when printing objects in JSON or YAML format.
    tcp [] Name of the manager used to track field ownership.
    generatorserviceaccount/v1The name of the API generator to use.
    output o If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.
    show-managed-fieldsfalseIf true, keep the managedFields when printing objects in JSON or YAML format.
    template When printing, show all labels as the last column (default hide labels column)
    show-managed-fieldsfalseIf true, keep the managedFields when printing objects in JSON or YAML format.
    sort-by If true, immediately remove resources from API and bypass graceful deletion. Note that immediate deletion of some resources may result in inconsistency or data loss and requires confirmation.
    generatorrun-pod/v1The name of the API generator to use, see http://kubernetes.io/docs/user-guide/kubectl-conventions/#generators for a list.
    grace-period -1
    quietq false If true, suppress prompt messages.
    Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
    replicasr1Number of replicas to create for this container. Default is 1.
    requests If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.
    scheduleA schedule in the Cron format the job should be run with.
    service-generatorservice/v2The name of the generator to use for creating a service. Only used if --expose is true
    service-overridesAn inline JSON override for the generated service object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field. Only used if --expose is true.
    serviceaccount Service account to set in the pod spec.
    show-managed-fieldsfalseIf true, keep the managedFields when printing objects in JSON or YAML format.
    stdin i false If non-empty, set the session affinity for the service to this; legal values: 'None', 'ClientIP'
    show-managed-fieldsfalseIf true, keep the managedFields when printing objects in JSON or YAML format.
    target-port If true, apply runs in the server instead of the client.
    show-managed-fieldsfalseIf true, keep the managedFields when printing objects in JSON or YAML format.
    template Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
    show-managed-fieldsfalseIf true, keep the managedFields when printing objects in JSON or YAML format.
    template Output format. One of: json|yaml|name|go-template|go-template-file|template|templatefile|jsonpath|jsonpath-as-json|jsonpath-file.
    show-managed-fieldsfalseIf true, keep the managedFields when printing objects in JSON or YAML format.
    template Selector (label query) to filter on, not including uninitialized ones, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2).
    show-managed-fieldsfalseIf true, keep the managedFields when printing objects in JSON or YAML format.
    template If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.
    show-managed-fieldsfalseIf true, keep the managedFields when printing objects in JSON or YAML format.
    template
    quietq false If true, suppress informational messages.
    If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.
    show-managed-fieldsfalseIf true, keep the managedFields when printing objects in JSON or YAML format.
    template
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameShorthandDefaultUsage
    allow-id-changesfalseenable changes to a resourceId
    enable-alpha-pluginsfalseenable kustomize plugins
    enable-managedby-labelfalseenable adding app.kubernetes.io/managed-by
    enve[]a list of environment variables to be used by functions
    load-restrictorLoadRestrictionsRootOnlyif set to 'LoadRestrictionsNone', local kustomizations may load files from outside their root. This does, however, break the relocatability of the kustomization.
    mount[]a list of storage options read from the filesystem
    networkfalseenable network access for functions that declare it
    network-namebridgethe docker network to run the container in
    outputoIf specified, write output to this path.
    reorderlegacyReorder the resources just before output. Use 'legacy' to apply a legacy reordering (Namespaces first, Webhooks last, etc). Use 'none' to suppress a final reordering.

    label

    @@ -4199,6 +4389,12 @@ viewing your workloads in a Kubernetes cluster.

    Selector (label query) to filter on, not including uninitialized ones, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). +show-managed-fields + +false +If true, keep the managedFields when printing objects in JSON or YAML format. + + template @@ -4315,6 +4511,12 @@ viewing your workloads in a Kubernetes cluster.

    Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. +show-managed-fields + +false +If true, keep the managedFields when printing objects in JSON or YAML format. + + template @@ -4439,6 +4641,12 @@ viewing your workloads in a Kubernetes cluster.

    If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. +show-managed-fields + +false +If true, keep the managedFields when printing objects in JSON or YAML format. + + template @@ -4548,6 +4756,12 @@ viewing your workloads in a Kubernetes cluster.

    See the details, including podTemplate of the revision specified +show-managed-fields + +false +If true, keep the managedFields when printing objects in JSON or YAML format. + + template @@ -4614,6 +4828,12 @@ viewing your workloads in a Kubernetes cluster.

    Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. +show-managed-fields + +false +If true, keep the managedFields when printing objects in JSON or YAML format. + + template @@ -4685,6 +4905,12 @@ viewing your workloads in a Kubernetes cluster.

    Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. +show-managed-fields + +false +If true, keep the managedFields when printing objects in JSON or YAML format. + + template @@ -4751,6 +4977,12 @@ viewing your workloads in a Kubernetes cluster.

    Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. +show-managed-fields + +false +If true, keep the managedFields when printing objects in JSON or YAML format. + + template @@ -4886,6 +5118,12 @@ viewing your workloads in a Kubernetes cluster.

    Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. +show-managed-fields + +false +If true, keep the managedFields when printing objects in JSON or YAML format. + + template @@ -5015,6 +5253,12 @@ viewing your workloads in a Kubernetes cluster.

    Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) +show-managed-fields + +false +If true, keep the managedFields when printing objects in JSON or YAML format. + + template @@ -5218,6 +5462,12 @@ viewing your workloads in a Kubernetes cluster.

    Selector (label query) to filter on +show-managed-fields + +false +If true, keep the managedFields when printing objects in JSON or YAML format. + + template @@ -5330,6 +5580,12 @@ viewing your workloads in a Kubernetes cluster.

    Selector (label query) to filter on, not including uninitialized ones, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) +show-managed-fields + +false +If true, keep the managedFields when printing objects in JSON or YAML format. + + template @@ -5460,6 +5716,12 @@ viewing your workloads in a Kubernetes cluster.

    Selector (label query) to filter on, not including uninitialized ones,supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) +show-managed-fields + +false +If true, keep the managedFields when printing objects in JSON or YAML format. + + template @@ -5551,6 +5813,12 @@ kubectl create deployment my-dep -o yaml --dry-run< If non-empty, the selectors update will only succeed if this is the current resource-version for the object. Only valid when specifying a single resource. +show-managed-fields + +false +If true, keep the managedFields when printing objects in JSON or YAML format. + + template @@ -5647,6 +5915,12 @@ kubectl create deployment my-dep -o yaml --dry-run< Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. +show-managed-fields + +false +If true, keep the managedFields when printing objects in JSON or YAML format. + + template @@ -5758,6 +6032,12 @@ kubectl create deployment my-dep -o yaml --dry-run< Service accounts to bind to the role +show-managed-fields + +false +If true, keep the managedFields when printing objects in JSON or YAML format. + + template @@ -5773,6 +6053,11 @@ kubectl create deployment my-dep -o yaml --dry-run<
    kubectl wait --for=condition=Ready pod/busybox1
     
    +

    The default value of status condition is true, you can set false.

    +
    +
    kubectl wait --for=condition=Ready=false pod/busybox1
    +
    +

    Wait for the pod "busybox1" to be deleted, with a timeout of 60s, after having issued the "delete" command.

    kubectl delete pod/busybox1
    @@ -5829,7 +6114,7 @@ kubectl wait --for=delete pod/busybox1 for
     
     
    -The condition to wait on: [delete|condition=condition-name]. 
    +The condition to wait on: [delete|condition=condition-name]. The default status value of condition-name is true, you can set false with condition=condition-name=false 
     
     
     local
    @@ -5856,6 +6141,12 @@ kubectl wait --for=delete pod/busybox1 Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 
     
     
    +show-managed-fields
    +
    +false
    +If true, keep the managedFields when printing objects in JSON or YAML format. 
    +
    +
     template
     
     
    @@ -5880,7 +6171,7 @@ applications.


    attach

    -

    Get output from running pod mypod, using the first container by default

    +

    Get output from running pod mypod, use the kubectl.kubernetes.io/default-container annotation # for selecting the container to be attached or the first container in the pod will be chosen

    kubectl attach mypod
     
    @@ -5917,7 +6208,7 @@ applications.

    container c -Container name. If omitted, the first container in the pod will be chosen +Container name. If omitted, use the kubectl.kubernetes.io/default-container annotation for selecting the container to be attached or the first container in the pod will be chosen pod-running-timeout @@ -5926,6 +6217,12 @@ applications.

    The length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running +quiet +q +false +Only print output from the remote session + + stdin i false @@ -6035,7 +6332,7 @@ applications.

    kubectl auth reconcile -f my-rbac-rules.yaml
     
    -

    Reconciles rules for RBAC Role, RoleBinding, ClusterRole, and ClusterRole binding objects.

    +

    Reconciles rules for RBAC Role, RoleBinding, ClusterRole, and ClusterRoleBinding objects.

    Missing objects are created, and the containing namespace is created for namespaced objects, if required.

    Existing roles are updated to include the permissions in the input objects, and remove extra permissions if --remove-extra-permissions is specified.

    Existing bindings are updated to include the subjects in the input objects, and remove extra subjects if --remove-extra-subjects is specified.

    @@ -6102,6 +6399,12 @@ applications.

    If true, removes extra subjects added to rolebindings +show-managed-fields + +false +If true, keep the managedFields when printing objects in JSON or YAML format. + + template @@ -6159,7 +6462,7 @@ applications.

    container c -Container name. If omitted, the first container in the pod will be chosen +Container name. If omitted, use the kubectl.kubernetes.io/default-container annotation for selecting the container to be attached or the first container in the pod will be chosen no-preserve @@ -6307,7 +6610,7 @@ applications.

    container c -Container name. If omitted, the first container in the pod will be chosen +Container name. If omitted, use the kubectl.kubernetes.io/default-container annotation for selecting the container to be attached or the first container in the pod will be chosen filename @@ -6322,6 +6625,12 @@ applications.

    The length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running +quiet +q +false +Only print output from the remote session + + stdin i false @@ -6568,22 +6877,22 @@ applications.


    proxy

    -

    To proxy all of the kubernetes api and nothing else, use:

    +

    To proxy all of the kubernetes api and nothing else.

    -
    $ kubectl proxy --api-prefix=/
    +
    kubectl proxy --api-prefix=/
     
    -

    To proxy only part of the kubernetes api and also some static files:

    +

    To proxy only part of the kubernetes api and also some static files. # You can get pods info with 'curl localhost:8001/api/v1/pods'

    -
    $ kubectl proxy --www=/my/files --www-prefix=/static/ --api-prefix=/api/
    +
    kubectl proxy --www=/my/files --www-prefix=/static/ --api-prefix=/api/
     
    -

    The above lets you 'curl localhost:8001/api/v1/pods'. # To proxy the entire kubernetes api at a different root, use:

    +

    To proxy the entire kubernetes api at a different root. # You can get pods info with 'curl localhost:8001/custom/api/v1/pods'

    -
    $ kubectl proxy --api-prefix=/custom/
    +
    kubectl proxy --api-prefix=/custom/
     
    -

    The above lets you 'curl localhost:8001/custom/api/v1/pods' # Run a proxy to kubernetes apiserver on port 8011, serving static content from ./local/www/

    +

    Run a proxy to kubernetes apiserver on port 8011, serving static content from ./local/www/

    kubectl proxy --port=8011 --www=./local/www/
     
    @@ -6687,7 +6996,7 @@ applications.


    top

    -

    Display Resource (CPU/Memory/Storage) usage.

    +

    Display Resource (CPU/Memory) usage.

    The top command allows you to see the resource consumption for nodes or pods.

    This command requires Metrics Server to be correctly configured and working on the server.

    Usage

    @@ -6704,7 +7013,7 @@ applications.

    kubectl top node NODE_NAME
     
    -

    Display Resource (CPU/Memory/Storage) usage of nodes.

    +

    Display Resource (CPU/Memory) usage of nodes.

    The top-node command allows you to see the resource consumption of nodes.

    Usage

    $ kubectl top node [NAME | -l label]

    @@ -6720,30 +7029,6 @@ applications.

    -heapster-namespace - -kube-system -Namespace Heapster service is located in - - -heapster-port - - -Port name in service to use - - -heapster-scheme - -http -Scheme (http or https) to connect to Heapster as - - -heapster-service - -heapster -Name of Heapster service - - no-headers false @@ -6761,6 +7046,12 @@ applications.

    If non-empty, sort nodes list using specified field. The field can be either 'cpu' or 'memory'. + +use-protocol-buffers + +false +If present, protocol-buffers will be used to request metrics. +
    @@ -6785,7 +7076,7 @@ applications.

    kubectl top pod -l name=myLabel
     
    -

    Display Resource (CPU/Memory/Storage) usage of pods.

    +

    Display Resource (CPU/Memory) usage of pods.

    The 'top pod' command allows you to see the resource consumption of pods.

    Due to the metrics pipeline delay, they may be unavailable for a few minutes since pod creation.

    Usage

    @@ -6831,6 +7122,12 @@ applications.

    If non-empty, sort pods list using specified field. The field can be either 'cpu' or 'memory'. + +use-protocol-buffers + +false +If present, protocol-buffers will be used to request metrics. +

    CLUSTER MANAGEMENT

    @@ -6904,6 +7201,12 @@ applications.

    Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. +show-managed-fields + +false +If true, keep the managedFields when printing objects in JSON or YAML format. + + template @@ -6965,6 +7268,12 @@ applications.

    Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. +show-managed-fields + +false +If true, keep the managedFields when printing objects in JSON or YAML format. + + template @@ -7056,6 +7365,12 @@ applications.

    The length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running +show-managed-fields + +false +If true, keep the managedFields when printing objects in JSON or YAML format. + + template @@ -7171,6 +7486,12 @@ applications.

    Ignore DaemonSet-managed pods. +ignore-errors + +false +Ignore errors occurred between drain nodes in group. + + pod-selector @@ -7288,6 +7609,12 @@ applications.

    Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) +show-managed-fields + +false +If true, keep the managedFields when printing objects in JSON or YAML format. + + template @@ -7343,157 +7670,6 @@ applications.

    Usage

    $ kubectl alpha


    -

    debug

    -
    -

    Create an interactive debugging session in pod mypod and immediately attach to it. # (requires the EphemeralContainers feature to be enabled in the cluster)

    -
    -
    kubectl debug mypod -it --image=busybox
    -
    -
    -

    Create a debug container named debugger using a custom automated debugging image. # (requires the EphemeralContainers feature to be enabled in the cluster)

    -
    -
    kubectl debug --image=myproj/debug-tools -c debugger mypod
    -
    -
    -

    Create a copy of mypod adding a debug container and attach to it

    -
    -
    kubectl debug mypod -it --image=busybox --copy-to=my-debugger
    -
    -
    -

    Create a copy of mypod changing the command of mycontainer

    -
    -
    kubectl debug mypod -it --copy-to=my-debugger --container=mycontainer -- sh
    -
    -
    -

    Create a copy of mypod changing all container images to busybox

    -
    -
    kubectl debug mypod --copy-to=my-debugger --set-image=*=busybox
    -
    -
    -

    Create a copy of mypod adding a debug container and changing container images

    -
    -
    kubectl debug mypod -it --copy-to=my-debugger --image=debian --set-image=app=app:debug,sidecar=sidecar:debug
    -
    -
    -

    Create an interactive debugging session on a node and immediately attach to it. # The container will run in the host namespaces and the host's filesystem will be mounted at /host

    -
    -
    kubectl debug node/mynode -it --image=busybox
    -
    -

    NOTE: "kubectl alpha debug" is deprecated and will be removed in release 1.21. Please use "kubectl debug" instead.

    -

    Debug cluster resources using interactive debugging containers.

    -

    'debug' provides automation for common debugging tasks for cluster objects identified by resource and name. Pods will be used by default if no resource is specified.

    -

    The action taken by 'debug' varies depending on what resource is specified. Supported actions include:

    -
      -
    • Workload: Create a copy of an existing pod with certain attributes changed, for example changing the image tag to a new version.
    • -
    • Workload: Add an ephemeral container to an already running pod, for example to add debugging utilities without restarting the pod.
    • -
    • Node: Create a new pod that runs in the node's host namespaces and can access the node's filesystem.
    • -
    -

    Usage

    -

    $ kubectl alpha debug (POD | TYPE[[.VERSION].GROUP]/NAME) [ -- COMMAND [args...] ]

    -

    Flags

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameShorthandDefaultUsage
    arguments-onlyfalseIf specified, everything after -- will be passed to the new container as Args instead of Command.
    attachfalseIf true, wait for the container to start running, and then attach as if 'kubectl attach ...' were called. Default false, unless '-i/--stdin' is set, in which case the default is true.
    containercContainer name to use for debug container.
    copy-toCreate a copy of the target Pod with this name.
    env[]Environment variables to set in the container.
    imageContainer image to use for debug container.
    image-pull-policyThe image pull policy for the container. If left empty, this value will not be specified by the client and defaulted by the server.
    quietfalseIf true, suppress informational messages.
    replacefalseWhen used with '--copy-to', delete the original Pod.
    same-nodefalseWhen used with '--copy-to', schedule the copy of target Pod on the same node.
    set-image[]When used with '--copy-to', a list of name=image pairs for changing container images, similar to how 'kubectl set image' works.
    share-processestrueWhen used with '--copy-to', enable process namespace sharing in the copy.
    stdinifalseKeep stdin open on the container(s) in the pod, even if nothing is attached.
    targetWhen using an ephemeral container, target processes in this container name.
    ttytfalseAllocate a TTY for the debugging container.
    -

    api-resources

    Print the supported API Resources

    @@ -7606,7 +7782,7 @@ applications.

    source <(kubectl completion bash)
     
    -

    Write bash completion code to a file and source if from .bash_profile

    +

    Write bash completion code to a file and source it from .bash_profile

    kubectl completion bash > ~/.kube/completion.bash.inc
     printf "
    @@ -8092,6 +8268,12 @@ source $HOME/.bash_profile
     Display raw byte data 
     
     
    +show-managed-fields
    +
    +false
    +If true, keep the managedFields when printing objects in JSON or YAML format. 
    +
    +
     template
     
     
    diff --git a/static/docs/reference/generated/kubectl/navData.js b/static/docs/reference/generated/kubectl/navData.js
    index e63115561c..e6f8f066de 100644
    --- a/static/docs/reference/generated/kubectl/navData.js
    +++ b/static/docs/reference/generated/kubectl/navData.js
    @@ -1 +1 @@
    -(function(){navData = {"toc":[{"section":"version","subsections":[]},{"section":"plugin","subsections":[{"section":"-em-list-em-"}]},{"section":"options","subsections":[]},{"section":"explain","subsections":[]},{"section":"config","subsections":[{"section":"-em-view-em-"},{"section":"-em-use-context-em-"},{"section":"-em-unset-em-"},{"section":"-em-set-credentials-em-"},{"section":"-em-set-context-em-"},{"section":"-em-set-cluster-em-"},{"section":"-em-set-em-"},{"section":"-em-rename-context-em-"},{"section":"-em-get-users-em-"},{"section":"-em-get-contexts-em-"},{"section":"-em-get-clusters-em-"},{"section":"-em-delete-user-em-"},{"section":"-em-delete-context-em-"},{"section":"-em-delete-cluster-em-"},{"section":"-em-current-context-em-"}]},{"section":"completion","subsections":[]},{"section":"api-resources","subsections":[]},{"section":"alpha","subsections":[{"section":"-em-debug-em-"}]},{"section":"-strong-kubectl-settings-and-usage-strong-","subsections":[]},{"section":"uncordon","subsections":[]},{"section":"taint","subsections":[]},{"section":"drain","subsections":[]},{"section":"cordon","subsections":[]},{"section":"cluster-info","subsections":[{"section":"-em-dump-em-"}]},{"section":"certificate","subsections":[{"section":"-em-deny-em-"},{"section":"-em-approve-em-"}]},{"section":"api-versions","subsections":[]},{"section":"-strong-cluster-management-strong-","subsections":[]},{"section":"top","subsections":[{"section":"-em-pod-em-"},{"section":"-em-node-em-"}]},{"section":"proxy","subsections":[]},{"section":"port-forward","subsections":[]},{"section":"logs","subsections":[]},{"section":"exec","subsections":[]},{"section":"describe","subsections":[]},{"section":"cp","subsections":[]},{"section":"auth","subsections":[{"section":"-em-reconcile-em-"},{"section":"-em-can-i-em-"}]},{"section":"attach","subsections":[]},{"section":"-strong-working-with-apps-strong-","subsections":[]},{"section":"wait","subsections":[]},{"section":"set","subsections":[{"section":"-em-subject-em-"},{"section":"-em-serviceaccount-em--1"},{"section":"-em-selector-em-"},{"section":"-em-resources-em-"},{"section":"-em-image-em-"},{"section":"-em-env-em-"}]},{"section":"scale","subsections":[]},{"section":"rollout","subsections":[{"section":"-em-undo-em-"},{"section":"-em-status-em-"},{"section":"-em-resume-em-"},{"section":"-em-restart-em-"},{"section":"-em-pause-em-"},{"section":"-em-history-em-"}]},{"section":"replace","subsections":[]},{"section":"patch","subsections":[]},{"section":"label","subsections":[]},{"section":"kustomize","subsections":[]},{"section":"edit","subsections":[]},{"section":"diff","subsections":[]},{"section":"debug","subsections":[]},{"section":"autoscale","subsections":[]},{"section":"annotate","subsections":[]},{"section":"apply","subsections":[{"section":"-em-view-last-applied-em-"},{"section":"-em-set-last-applied-em-"},{"section":"-em-edit-last-applied-em-"}]},{"section":"-strong-app-management-strong-","subsections":[]},{"section":"delete","subsections":[]},{"section":"expose","subsections":[]},{"section":"run","subsections":[]},{"section":"get","subsections":[]},{"section":"create","subsections":[{"section":"-em-serviceaccount-em-"},{"section":"-em-service-nodeport-em-"},{"section":"-em-service-loadbalancer-em-"},{"section":"-em-service-externalname-em-"},{"section":"-em-service-clusterip-em-"},{"section":"-em-service-em-"},{"section":"-em-secret-tls-em-"},{"section":"-em-secret-generic-em-"},{"section":"-em-secret-docker-registry-em-"},{"section":"-em-secret-em-"},{"section":"-em-rolebinding-em-"},{"section":"-em-role-em-"},{"section":"-em-quota-em-"},{"section":"-em-priorityclass-em-"},{"section":"-em-poddisruptionbudget-em-"},{"section":"-em-namespace-em-"},{"section":"-em-job-em-"},{"section":"-em-ingress-em-"},{"section":"-em-deployment-em-"},{"section":"-em-cronjob-em-"},{"section":"-em-configmap-em-"},{"section":"-em-clusterrolebinding-em-"},{"section":"-em-clusterrole-em-"}]},{"section":"-strong-getting-started-strong-","subsections":[]}],"flatToc":["version","-em-list-em-","plugin","options","explain","-em-view-em-","-em-use-context-em-","-em-unset-em-","-em-set-credentials-em-","-em-set-context-em-","-em-set-cluster-em-","-em-set-em-","-em-rename-context-em-","-em-get-users-em-","-em-get-contexts-em-","-em-get-clusters-em-","-em-delete-user-em-","-em-delete-context-em-","-em-delete-cluster-em-","-em-current-context-em-","config","completion","api-resources","-em-debug-em-","alpha","-strong-kubectl-settings-and-usage-strong-","uncordon","taint","drain","cordon","-em-dump-em-","cluster-info","-em-deny-em-","-em-approve-em-","certificate","api-versions","-strong-cluster-management-strong-","-em-pod-em-","-em-node-em-","top","proxy","port-forward","logs","exec","describe","cp","-em-reconcile-em-","-em-can-i-em-","auth","attach","-strong-working-with-apps-strong-","wait","-em-subject-em-","-em-serviceaccount-em--1","-em-selector-em-","-em-resources-em-","-em-image-em-","-em-env-em-","set","scale","-em-undo-em-","-em-status-em-","-em-resume-em-","-em-restart-em-","-em-pause-em-","-em-history-em-","rollout","replace","patch","label","kustomize","edit","diff","debug","autoscale","annotate","-em-view-last-applied-em-","-em-set-last-applied-em-","-em-edit-last-applied-em-","apply","-strong-app-management-strong-","delete","expose","run","get","-em-serviceaccount-em-","-em-service-nodeport-em-","-em-service-loadbalancer-em-","-em-service-externalname-em-","-em-service-clusterip-em-","-em-service-em-","-em-secret-tls-em-","-em-secret-generic-em-","-em-secret-docker-registry-em-","-em-secret-em-","-em-rolebinding-em-","-em-role-em-","-em-quota-em-","-em-priorityclass-em-","-em-poddisruptionbudget-em-","-em-namespace-em-","-em-job-em-","-em-ingress-em-","-em-deployment-em-","-em-cronjob-em-","-em-configmap-em-","-em-clusterrolebinding-em-","-em-clusterrole-em-","create","-strong-getting-started-strong-"]};})();
    \ No newline at end of file
    +(function(){navData = {"toc":[{"section":"version","subsections":[]},{"section":"plugin","subsections":[{"section":"-em-list-em-"}]},{"section":"options","subsections":[]},{"section":"explain","subsections":[]},{"section":"config","subsections":[{"section":"-em-view-em-"},{"section":"-em-use-context-em-"},{"section":"-em-unset-em-"},{"section":"-em-set-credentials-em-"},{"section":"-em-set-context-em-"},{"section":"-em-set-cluster-em-"},{"section":"-em-set-em-"},{"section":"-em-rename-context-em-"},{"section":"-em-get-users-em-"},{"section":"-em-get-contexts-em-"},{"section":"-em-get-clusters-em-"},{"section":"-em-delete-user-em-"},{"section":"-em-delete-context-em-"},{"section":"-em-delete-cluster-em-"},{"section":"-em-current-context-em-"}]},{"section":"completion","subsections":[]},{"section":"api-resources","subsections":[]},{"section":"alpha","subsections":[]},{"section":"-strong-kubectl-settings-and-usage-strong-","subsections":[]},{"section":"uncordon","subsections":[]},{"section":"taint","subsections":[]},{"section":"drain","subsections":[]},{"section":"cordon","subsections":[]},{"section":"cluster-info","subsections":[{"section":"-em-dump-em-"}]},{"section":"certificate","subsections":[{"section":"-em-deny-em-"},{"section":"-em-approve-em-"}]},{"section":"api-versions","subsections":[]},{"section":"-strong-cluster-management-strong-","subsections":[]},{"section":"top","subsections":[{"section":"-em-pod-em-"},{"section":"-em-node-em-"}]},{"section":"proxy","subsections":[]},{"section":"port-forward","subsections":[]},{"section":"logs","subsections":[]},{"section":"exec","subsections":[]},{"section":"describe","subsections":[]},{"section":"cp","subsections":[]},{"section":"auth","subsections":[{"section":"-em-reconcile-em-"},{"section":"-em-can-i-em-"}]},{"section":"attach","subsections":[]},{"section":"-strong-working-with-apps-strong-","subsections":[]},{"section":"wait","subsections":[]},{"section":"set","subsections":[{"section":"-em-subject-em-"},{"section":"-em-serviceaccount-em--1"},{"section":"-em-selector-em-"},{"section":"-em-resources-em-"},{"section":"-em-image-em-"},{"section":"-em-env-em-"}]},{"section":"scale","subsections":[]},{"section":"rollout","subsections":[{"section":"-em-undo-em-"},{"section":"-em-status-em-"},{"section":"-em-resume-em-"},{"section":"-em-restart-em-"},{"section":"-em-pause-em-"},{"section":"-em-history-em-"}]},{"section":"replace","subsections":[]},{"section":"patch","subsections":[]},{"section":"label","subsections":[]},{"section":"kustomize","subsections":[]},{"section":"edit","subsections":[]},{"section":"diff","subsections":[]},{"section":"debug","subsections":[]},{"section":"autoscale","subsections":[]},{"section":"annotate","subsections":[]},{"section":"apply","subsections":[{"section":"-em-view-last-applied-em-"},{"section":"-em-set-last-applied-em-"},{"section":"-em-edit-last-applied-em-"}]},{"section":"-strong-app-management-strong-","subsections":[]},{"section":"delete","subsections":[]},{"section":"expose","subsections":[]},{"section":"run","subsections":[]},{"section":"get","subsections":[]},{"section":"create","subsections":[{"section":"-em-serviceaccount-em-"},{"section":"-em-service-nodeport-em-"},{"section":"-em-service-loadbalancer-em-"},{"section":"-em-service-externalname-em-"},{"section":"-em-service-clusterip-em-"},{"section":"-em-service-em-"},{"section":"-em-secret-tls-em-"},{"section":"-em-secret-generic-em-"},{"section":"-em-secret-docker-registry-em-"},{"section":"-em-secret-em-"},{"section":"-em-rolebinding-em-"},{"section":"-em-role-em-"},{"section":"-em-quota-em-"},{"section":"-em-priorityclass-em-"},{"section":"-em-poddisruptionbudget-em-"},{"section":"-em-namespace-em-"},{"section":"-em-job-em-"},{"section":"-em-ingress-em-"},{"section":"-em-deployment-em-"},{"section":"-em-cronjob-em-"},{"section":"-em-configmap-em-"},{"section":"-em-clusterrolebinding-em-"},{"section":"-em-clusterrole-em-"}]},{"section":"-strong-getting-started-strong-","subsections":[]}],"flatToc":["version","-em-list-em-","plugin","options","explain","-em-view-em-","-em-use-context-em-","-em-unset-em-","-em-set-credentials-em-","-em-set-context-em-","-em-set-cluster-em-","-em-set-em-","-em-rename-context-em-","-em-get-users-em-","-em-get-contexts-em-","-em-get-clusters-em-","-em-delete-user-em-","-em-delete-context-em-","-em-delete-cluster-em-","-em-current-context-em-","config","completion","api-resources","alpha","-strong-kubectl-settings-and-usage-strong-","uncordon","taint","drain","cordon","-em-dump-em-","cluster-info","-em-deny-em-","-em-approve-em-","certificate","api-versions","-strong-cluster-management-strong-","-em-pod-em-","-em-node-em-","top","proxy","port-forward","logs","exec","describe","cp","-em-reconcile-em-","-em-can-i-em-","auth","attach","-strong-working-with-apps-strong-","wait","-em-subject-em-","-em-serviceaccount-em--1","-em-selector-em-","-em-resources-em-","-em-image-em-","-em-env-em-","set","scale","-em-undo-em-","-em-status-em-","-em-resume-em-","-em-restart-em-","-em-pause-em-","-em-history-em-","rollout","replace","patch","label","kustomize","edit","diff","debug","autoscale","annotate","-em-view-last-applied-em-","-em-set-last-applied-em-","-em-edit-last-applied-em-","apply","-strong-app-management-strong-","delete","expose","run","get","-em-serviceaccount-em-","-em-service-nodeport-em-","-em-service-loadbalancer-em-","-em-service-externalname-em-","-em-service-clusterip-em-","-em-service-em-","-em-secret-tls-em-","-em-secret-generic-em-","-em-secret-docker-registry-em-","-em-secret-em-","-em-rolebinding-em-","-em-role-em-","-em-quota-em-","-em-priorityclass-em-","-em-poddisruptionbudget-em-","-em-namespace-em-","-em-job-em-","-em-ingress-em-","-em-deployment-em-","-em-cronjob-em-","-em-configmap-em-","-em-clusterrolebinding-em-","-em-clusterrole-em-","create","-strong-getting-started-strong-"]};})();
    \ No newline at end of file
    diff --git a/static/docs/reference/generated/kubernetes-api/v1.21/index.html b/static/docs/reference/generated/kubernetes-api/v1.21/index.html
    new file mode 100644
    index 0000000000..ddab130403
    --- /dev/null
    +++ b/static/docs/reference/generated/kubernetes-api/v1.21/index.html
    @@ -0,0 +1,52412 @@
    +
    +
    +
    +
    +Kubernetes API Reference Docs
    +
    +
    +
    +
    +
    +
    +
    +
    + +
    +
    + +
    +
    Generated at: 2021-04-01 16:11:53 (PDT)
    +
    API Version: v1.21.0
    +
    +

    API OVERVIEW

    + +

    Welcome to the Kubernetes API. You can use the Kubernetes API to read +and write Kubernetes resource objects via a Kubernetes API endpoint.

    + +

    Resource Categories

    + +

    This is a high-level overview of the basic types of resources provide by the Kubernetes API and their primary functions.

    +

    Workloads are objects you use to manage and run your containers on the cluster.

    +

    Discovery & LB resources are objects you use to "stitch" your workloads together into an externally accessible, load-balanced Service.

    +

    Config & Storage resources are objects you use to inject initialization data into your applications, and to persist data that is external to your container.

    +

    Cluster resources objects define how the cluster itself is configured; these are typically used only by cluster operators.

    +

    Metadata resources are objects you use to configure the behavior of other resources within the cluster, such as HorizontalPodAutoscaler for scaling workloads.

    + +
    + +

    Resource Objects

    + +

    Resource objects typically have 3 components:

    +
      +
    • Resource ObjectMeta: This is metadata about the resource, such as its name, type, api version, annotations, and labels. This contains +fields that maybe updated both by the end user and the system (e.g. annotations).
    • +
    • ResourceSpec: This is defined by the user and describes the desired state of system. Fill this in when creating or updating an object.
    • +
    • ResourceStatus: This is filled in by the server and reports the current state of the system. In most cases, users don't need to change this.
    • +
    + +
    + +

    Resource Operations

    + +

    Most resources provide the following Operations:

    + +

    Create

    + +

    Create operations will create the resource in the storage backend. After a resource is create the system will apply +the desired state.

    + +

    Update

    + +

    Updates come in 2 forms: Replace and Patch: + +

      +
    • Replace: +Replacing a resource object will update the resource by replacing the existing spec with the provided one. For +read-then-write operations this is safe because an optimistic lock failure will occur if the resource was modified +between the read and write. Note: The ResourceStatus will be ignored by the system and will not be updated. +To update the status, one must invoke the specific status update operation.
      + +Note: Replacing a resource object may not result immediately in changes being propagated to downstream objects. For instance +replacing a ConfigMap or Secret resource will not result in all Pods seeing the changes unless the Pods are +restarted out of band.

    • + +
    • Patch: +Patch will apply a change to a specific field. How the change is merged is defined per field. Lists may either be +replaced or merged. Merging lists will not preserve ordering.
      + +Patches will never cause optimistic locking failures, and the last write will win. Patches are recommended +when the full state is not read before an update, or when failing on optimistic locking is undesirable. When patching +complex types, arrays and maps, how the patch is applied is defined on a per-field basis and may either replace +the field's current value, or merge the contents into the current value.
    • +
    + +

    Read

    + +

    Reads come in 3 forms: Get, List and Watch:

    + +

      +
    • Get: Get will retrieve a specific resource object by name.
    • +
    • List: List will retrieve all resource objects of a specific type within a namespace, and the results can be restricted to resources matching a selector query.
      +List All Namespaces: Like List but retrieves resources across all namespaces.
    • +
    • Watch: Watch will stream results for an object(s) as it is updated. Similar to a callback, watch is used to respond to resource changes.
    • +
    + +

    Delete

    + +

    Delete will delete a resource. Depending on the specific resource, child objects may or may not be garbage collected by the server. See +notes on specific resource objects for details.

    + +

    Additional Operations

    + +

    Resources may define additional operations specific to that resource type.

    + +
      +
    • Rollback: Rollback a PodTemplate to a previous version. Only available for some resource types.
    • +
    • Read / Write Scale: Read or Update the number of replicas for the given resource. Only available for some resource types.
    • +
    • Read / Write Status: Read or Update the Status for a resource object. The Status can only changed through these update operations.
    • +
    +
    +

    API Groups

    +

    The API Groups and their versions are summarized in the following table.

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    GroupVersion
    admissionregistration.k8s.iov1, v1beta1
    apiextensions.k8s.iov1, v1beta1
    apiregistration.k8s.iov1, v1beta1
    appsv1
    authentication.k8s.iov1, v1beta1
    authorization.k8s.iov1, v1beta1
    autoscalingv1, v2beta2, v2beta1
    batchv1, v1beta1
    certificates.k8s.iov1, v1beta1
    coordination.k8s.iov1, v1beta1
    corev1
    discovery.k8s.iov1, v1beta1
    events.k8s.iov1, v1beta1
    extensionsv1beta1
    flowcontrol.apiserver.k8s.iov1beta1
    internal.apiserver.k8s.iov1alpha1
    networking.k8s.iov1, v1beta1
    node.k8s.iov1, v1beta1, v1alpha1
    policyv1, v1beta1
    rbac.authorization.k8s.iov1, v1beta1, v1alpha1
    scheduling.k8s.iov1, v1beta1, v1alpha1
    storage.k8s.iov1, v1beta1, v1alpha1
    +

    WORKLOADS

    + +

    Workloads resources are responsible for managing and running your containers on the cluster. Containers are created +by Controllers through Pods. Pods run Containers and provide environmental dependencies such as shared or +persistent storage Volumes and Configuration or Secret +data injected into the container.

    + +

    The most common Controllers are:

    +
      +
    • Deployments for stateless persistent apps (e.g. HTTP servers).
    • +
    • StatefulSets for stateful persistent apps (e.g. databases).
    • +
    • Jobs for run-to-completion apps (e.g. batch Jobs).
    • +
    + +
    +

    Container v1 core

    + +
    +
    +
    Container Config to run nginx (must be embedded in a PodSpec to run).
    +
    +
    
    +name: nginx
    +# Run the nginx:1.14 image
    +image: nginx:1.14
    +
    +
    + + + + + +
    GroupVersionKind
    corev1Container
    +

    Warning:

    Containers are only ever created within the context of a Pod. This is usually done using a Controller. See Controllers: Deployment, Job, or StatefulSet

    +
    Appears In: + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    args
    string array
    Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
    command
    string array
    Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
    env
    EnvVar array
    patch strategy: merge
    patch merge key: name
    List of environment variables to set in the container. Cannot be updated.
    envFrom
    EnvFromSource array
    List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
    image
    string
    Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.
    imagePullPolicy
    string
    Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
    lifecycle
    Lifecycle
    Actions that the management system should take in response to container lifecycle events. Cannot be updated.
    livenessProbe
    Probe
    Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
    name
    string
    Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
    ports
    ContainerPort array
    patch strategy: merge
    patch merge key: containerPort
    List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated.
    readinessProbe
    Probe
    Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
    resources
    ResourceRequirements
    Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
    securityContext
    SecurityContext
    Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
    startupProbe
    Probe
    StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
    stdin
    boolean
    Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.
    stdinOnce
    boolean
    Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false
    terminationMessagePath
    string
    Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.
    terminationMessagePolicy
    string
    Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
    tty
    boolean
    Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
    volumeDevices
    VolumeDevice array
    patch strategy: merge
    patch merge key: devicePath
    volumeDevices is the list of block devices to be used by the container.
    volumeMounts
    VolumeMount array
    patch strategy: merge
    patch merge key: mountPath
    Pod volumes to mount into the container's filesystem. Cannot be updated.
    workingDir
    string
    Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.
    +

    ContainerStatus v1 core

    +
    Appears In: + +
    + + + + + + + + + + + + + +
    FieldDescription
    containerID
    string
    Container's ID in the format 'docker://<container_id>'.
    image
    string
    The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images
    imageID
    string
    ImageID of the container's image.
    lastState
    ContainerState
    Details about the container's last termination condition.
    name
    string
    This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated.
    ready
    boolean
    Specifies whether the container has passed its readiness probe.
    restartCount
    integer
    The number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed. Note that this is calculated from dead containers. But those containers are subject to garbage collection. This value will get capped at 5 by GC.
    started
    boolean
    Specifies whether the container has passed its startup probe. Initialized as false, becomes true after startupProbe is considered successful. Resets to false when the container is restarted, or if kubelet loses state temporarily. Is always true when no startupProbe is defined.
    state
    ContainerState
    Details about the container's current condition.
    +

    CronJob v1beta1 batch

    + + + + + +
    GroupVersionKind
    batchv1beta1CronJob
    +
    Other API versions of this object exist: +v1 +
    +
    Appears In: + +
    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    spec
    CronJobSpec
    Specification of the desired behavior of a cron job, including the schedule. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    status
    CronJobStatus
    Current status of a cron job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    +

    CronJobSpec v1beta1 batch

    +
    Appears In: + +
    + + + + + + + + + + + +
    FieldDescription
    concurrencyPolicy
    string
    Specifies how to treat concurrent executions of a Job. Valid values are: - "Allow" (default): allows CronJobs to run concurrently; - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet; - "Replace": cancels currently running job and replaces it with a new one
    failedJobsHistoryLimit
    integer
    The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
    jobTemplate
    JobTemplateSpec
    Specifies the job that will be created when executing a CronJob.
    schedule
    string
    The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
    startingDeadlineSeconds
    integer
    Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones.
    successfulJobsHistoryLimit
    integer
    The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 3.
    suspend
    boolean
    This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.
    +

    CronJobStatus v1beta1 batch

    +
    Appears In: + +
    + + + + + + + +
    FieldDescription
    active
    ObjectReference array
    A list of pointers to currently running jobs.
    lastScheduleTime
    Time
    Information when was the last time the job was successfully scheduled.
    lastSuccessfulTime
    Time
    Information when was the last time the job successfully completed.
    +

    CronJobList v1beta1 batch

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    CronJob array
    items is the list of CronJobs.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    +

    Write Operations

    +

    Create

    +

    create a CronJob

    +

    HTTP Request

    +POST /apis/batch/v1beta1/namespaces/{namespace}/cronjobs +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    CronJob
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    CronJob
    OK
    201
    CronJob
    Created
    202
    CronJob
    Accepted
    +

    Patch

    +

    partially update the specified CronJob

    +

    HTTP Request

    +PATCH /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the CronJob
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    CronJob
    OK
    +

    Replace

    +

    replace the specified CronJob

    +

    HTTP Request

    +PUT /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the CronJob
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    CronJob
    +

    Response

    + + + + + + +
    CodeDescription
    200
    CronJob
    OK
    201
    CronJob
    Created
    +

    Delete

    +

    delete a CronJob

    +

    HTTP Request

    +DELETE /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the CronJob
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of CronJob

    +

    HTTP Request

    +DELETE /apis/batch/v1beta1/namespaces/{namespace}/cronjobs +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified CronJob

    +

    HTTP Request

    +GET /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the CronJob
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    CronJob
    OK
    +

    List

    +

    list or watch objects of kind CronJob

    +

    HTTP Request

    +GET /apis/batch/v1beta1/namespaces/{namespace}/cronjobs +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    CronJobList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind CronJob

    +

    HTTP Request

    +GET /apis/batch/v1beta1/cronjobs +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    CronJobList
    OK
    +

    Watch

    +

    watch changes to an object of kind CronJob. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/batch/v1beta1/watch/namespaces/{namespace}/cronjobs/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the CronJob
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of CronJob. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/batch/v1beta1/watch/namespaces/{namespace}/cronjobs +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of CronJob. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/batch/v1beta1/watch/cronjobs +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Status Operations

    +

    Patch Status

    +

    partially update status of the specified CronJob

    +

    HTTP Request

    +PATCH /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the CronJob
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    CronJob
    OK
    +

    Read Status

    +

    read status of the specified CronJob

    +

    HTTP Request

    +GET /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the CronJob
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    CronJob
    OK
    +

    Replace Status

    +

    replace status of the specified CronJob

    +

    HTTP Request

    +PUT /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the CronJob
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    CronJob
    +

    Response

    + + + + + + +
    CodeDescription
    200
    CronJob
    OK
    201
    CronJob
    Created
    +

    DaemonSet v1 apps

    + +
    +
    +
    DaemonSet Config to print the `hostname` on each Node in the cluster every 10 seconds.
    +
    +
    
    +apiVersion: apps/v1
    +kind: DaemonSet
    +metadata:
    +  # Unique key of the DaemonSet instance
    +  name: daemonset-example
    +spec:
    +  selector:
    +    matchLabels:
    +      app: daemonset-example
    +  template:
    +    metadata:
    +      labels:
    +        app: daemonset-example
    +    spec:
    +      containers:
    +      # This container is run once on each Node in the cluster
    +      - name: daemonset-example
    +        image: ubuntu:trusty
    +        command:
    +        - /bin/sh
    +        args:
    +        - -c
    +        # This script is run through `sh -c <script>`
    +        - >-
    +          while [ true ]; do
    +          echo "DaemonSet running on $(hostname)" ;
    +          sleep 10 ;
    +          done
    +
    + + + + + +
    GroupVersionKind
    appsv1DaemonSet
    +
    Appears In: + +
    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    spec
    DaemonSetSpec
    The desired behavior of this daemon set. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    status
    DaemonSetStatus
    The current status of this daemon set. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    +

    DaemonSetSpec v1 apps

    +
    Appears In: + +
    + + + + + + + + + +
    FieldDescription
    minReadySeconds
    integer
    The minimum number of seconds for which a newly created DaemonSet pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready).
    revisionHistoryLimit
    integer
    The number of old history to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.
    selector
    LabelSelector
    A label query over pods that are managed by the daemon set. Must match in order to be controlled. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
    template
    PodTemplateSpec
    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
    updateStrategy
    DaemonSetUpdateStrategy
    An update strategy to replace existing DaemonSet pods with new pods.
    +

    DaemonSetStatus v1 apps

    +
    Appears In: + +
    + + + + + + + + + + + + + + +
    FieldDescription
    collisionCount
    integer
    Count of hash collisions for the DaemonSet. The DaemonSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision.
    conditions
    DaemonSetCondition array
    patch strategy: merge
    patch merge key: type
    Represents the latest available observations of a DaemonSet's current state.
    currentNumberScheduled
    integer
    The number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
    desiredNumberScheduled
    integer
    The total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
    numberAvailable
    integer
    The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and available (ready for at least spec.minReadySeconds)
    numberMisscheduled
    integer
    The number of nodes that are running the daemon pod, but are not supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
    numberReady
    integer
    The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready.
    numberUnavailable
    integer
    The number of nodes that should be running the daemon pod and have none of the daemon pod running and available (ready for at least spec.minReadySeconds)
    observedGeneration
    integer
    The most recent generation observed by the daemon set controller.
    updatedNumberScheduled
    integer
    The total number of nodes that are running updated daemon pod
    +

    DaemonSetList v1 apps

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    DaemonSet array
    A list of daemon sets.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    +

    RollingUpdateDaemonSet v1 apps

    + + + + + + + +
    FieldDescription
    maxSurgeThe maximum number of nodes with an existing available DaemonSet pod that can have an updated DaemonSet pod during during an update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up to a minimum of 1. Default value is 0. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their a new pod created before the old pod is marked as deleted. The update starts by launching new pods on 30% of nodes. Once an updated pod is available (Ready for at least minReadySeconds) the old DaemonSet pod on that node is marked deleted. If the old pod becomes unavailable for any reason (Ready transitions to false, is evicted, or is drained) an updated pod is immediatedly created on that node without considering surge limits. Allowing surge implies the possibility that the resources consumed by the daemonset on any given node can double if the readiness check fails, and so resource intensive daemonsets should take into account that they may cause evictions during disruption. This is an alpha field and requires enabling DaemonSetUpdateSurge feature gate.
    maxUnavailableThe maximum number of DaemonSet pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of total number of DaemonSet pods at the start of the update (ex: 10%). Absolute number is calculated from percentage by rounding down to a minimum of one. This cannot be 0 if MaxSurge is 0 Default value is 1. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their pods stopped for an update at any given time. The update starts by stopping at most 30% of those DaemonSet pods and then brings up new DaemonSet pods in their place. Once the new pods are available, it then proceeds onto other DaemonSet pods, thus ensuring that at least 70% of original number of DaemonSet pods are available at all times during the update.
    +

    Write Operations

    +

    Create

    + + +
    +
    +
    kubectl command
    +
    +
    
    +$ echo 'apiVersion: apps/v1
    +kind: DaemonSet
    +metadata:
    +  name: daemonset-example
    +spec:
    +  selector:
    +    matchLabels:
    +      app: daemonset-example
    +  template:
    +    metadata:
    +      labels:
    +        app: daemonset-example
    +    spec:
    +      containers:
    +      - name: daemonset-example
    +        image: ubuntu:trusty
    +        command:
    +        - /bin/sh
    +        args:
    +        - -c
    +        - >-
    +          while [ true ]; do
    +          echo "DaemonSet running on $(hostname)" ;
    +          sleep 10 ;
    +          done
    +' | kubectl create -f -
    +
    +
    +
    +
    curl command (requires kubectl proxy to be running)
    +
    +
    
    +$ kubectl proxy
    +$ curl -X POST -H 'Content-Type: application/yaml' --data '
    +apiVersion: apps/v1
    +kind: DaemonSet
    +metadata:
    +  name: daemonset-example
    +spec:
    +  selector:
    +    matchLabels:
    +      app: daemonset-example
    +  template:
    +    metadata:
    +      labels:
    +        app: daemonset-example
    +    spec:
    +      containers:
    +      - name: daemonset-example
    +        image: ubuntu:trusty
    +        command:
    +        - /bin/sh
    +        args:
    +        - -c
    +        - >-
    +          while [ true ]; do
    +          echo "DaemonSet running on $(hostname)" ;
    +          sleep 10 ;
    +          done
    +' http://127.0.0.1:8001/apis/apps/v1/namespaces/default/daemonsets
    +
    + + +
    +
    +
    Output
    +
    +
    
    +daemonset "daemonset-example" created
    +
    +
    +
    +
    Response Body
    +
    +
    
    +{
    +  "kind": "DaemonSet",
    +  "apiVersion": "apps/v1",
    +  "metadata": {
    +    "name": "daemonset-example",
    +    "namespace": "default",
    +    "selfLink": "/apis/apps/v1/namespaces/default/daemonsets/daemonset-example",
    +    "uid": "65552ced-b0e2-11e6-aef0-42010af00229",
    +    "resourceVersion": "3558",
    +    "generation": 1,
    +    "creationTimestamp": "2016-11-22T18:35:09Z",
    +    "labels": {
    +      "app": "daemonset-example"
    +    }
    +  },
    +  "spec": {
    +    "selector": {
    +      "matchLabels": {
    +        "app": "daemonset-example"
    +      }
    +    },
    +    "template": {
    +      "metadata": {
    +        "creationTimestamp": null,
    +        "labels": {
    +          "app": "daemonset-example"
    +        }
    +      },
    +      "spec": {
    +        "containers": [
    +          {
    +            "name": "daemonset-example",
    +            "image": "ubuntu:trusty",
    +            "command": [
    +              "/bin/sh"
    +            ],
    +            "args": [
    +              "-c",
    +              "while [ true ]; do echo \"DaemonSet running on $(hostname)\" ; sleep 10 ; done"
    +            ],
    +            "resources": {},
    +            "terminationMessagePath": "/dev/termination-log",
    +            "imagePullPolicy": "IfNotPresent"
    +          }
    +        ],
    +        "restartPolicy": "Always",
    +        "terminationGracePeriodSeconds": 30,
    +        "dnsPolicy": "ClusterFirst",
    +        "securityContext": {}
    +      }
    +    }
    +  },
    +  "status": {
    +    "currentNumberScheduled": 0,
    +    "numberMisscheduled": 0,
    +    "desiredNumberScheduled": 0
    +  }
    +}
    +
    +

    create a DaemonSet

    +

    HTTP Request

    +POST /apis/apps/v1/namespaces/{namespace}/daemonsets +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DaemonSet
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    DaemonSet
    OK
    201
    DaemonSet
    Created
    202
    DaemonSet
    Accepted
    +

    Patch

    +

    partially update the specified DaemonSet

    +

    HTTP Request

    +PATCH /apis/apps/v1/namespaces/{namespace}/daemonsets/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the DaemonSet
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    DaemonSet
    OK
    +

    Replace

    +

    replace the specified DaemonSet

    +

    HTTP Request

    +PUT /apis/apps/v1/namespaces/{namespace}/daemonsets/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the DaemonSet
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DaemonSet
    +

    Response

    + + + + + + +
    CodeDescription
    200
    DaemonSet
    OK
    201
    DaemonSet
    Created
    +

    Delete

    + + +
    +
    +
    kubectl command
    +
    +
    
    +$ kubectl delete daemonset daemonset-example
    +
    +
    +
    +
    curl command (requires kubectl proxy to be running)
    +
    +
    
    +$ kubectl proxy
    +$ curl -X DELETE -H 'Content-Type: application/yaml' --data '
    +gracePeriodSeconds: 0
    +orphanDependents: false
    +' 'http://127.0.0.1:8001/apis/apps/v1/namespaces/default/daemonsets/daemonset-example'
    +
    + + +
    +
    +
    Output
    +
    +
    
    +daemonset "daemonset-example" deleted
    +
    +
    +
    +
    Response Body
    +
    +
    
    +{
    +  "kind": "Status",
    +  "apiVersion": "v1",
    +  "metadata": {},
    +  "status": "Success",
    +  "code": 200
    +}
    +
    +
    +

    delete a DaemonSet

    +

    HTTP Request

    +DELETE /apis/apps/v1/namespaces/{namespace}/daemonsets/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the DaemonSet
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of DaemonSet

    +

    HTTP Request

    +DELETE /apis/apps/v1/namespaces/{namespace}/daemonsets +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    + + +
    +
    +
    kubectl command
    +
    +
    
    +$ kubectl get daemonset daemonset-example -o json
    +
    +
    +
    +
    curl command (requires kubectl proxy to be running)
    +
    +
    
    +$ kubectl proxy
    +$ curl -X GET http://127.0.0.1:8001/apis/apps/v1/namespaces/default/daemonsets/daemonset-example
    +
    +

    read the specified DaemonSet

    +

    HTTP Request

    +GET /apis/apps/v1/namespaces/{namespace}/daemonsets/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the DaemonSet
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    DaemonSet
    OK
    +

    List

    +

    list or watch objects of kind DaemonSet

    +

    HTTP Request

    +GET /apis/apps/v1/namespaces/{namespace}/daemonsets +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    DaemonSetList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind DaemonSet

    +

    HTTP Request

    +GET /apis/apps/v1/daemonsets +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    DaemonSetList
    OK
    +

    Watch

    +

    watch changes to an object of kind DaemonSet. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/apps/v1/watch/namespaces/{namespace}/daemonsets/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the DaemonSet
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of DaemonSet. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/apps/v1/watch/namespaces/{namespace}/daemonsets +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of DaemonSet. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/apps/v1/watch/daemonsets +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Status Operations

    +

    Patch Status

    +

    partially update status of the specified DaemonSet

    +

    HTTP Request

    +PATCH /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the DaemonSet
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    DaemonSet
    OK
    +

    Read Status

    +

    read status of the specified DaemonSet

    +

    HTTP Request

    +GET /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the DaemonSet
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    DaemonSet
    OK
    +

    Replace Status

    +

    replace status of the specified DaemonSet

    +

    HTTP Request

    +PUT /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the DaemonSet
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DaemonSet
    +

    Response

    + + + + + + +
    CodeDescription
    200
    DaemonSet
    OK
    201
    DaemonSet
    Created
    +

    Deployment v1 apps

    + +
    +
    +
    Deployment Config to run 3 nginx instances (max rollback set to 10 revisions).
    +
    +
    
    +apiVersion: apps/v1
    +kind: Deployment
    +metadata:
    +  # Unique key of the Deployment instance
    +  name: deployment-example
    +spec:
    +  # 3 Pods should exist at all times.
    +  replicas: 3
    +  selector:
    +    matchLabels:
    +      app: nginx
    +  template:
    +    metadata:
    +      labels:
    +        # Apply this label to pods and default
    +        # the Deployment label selector to this value
    +        app: nginx
    +    spec:
    +      containers:
    +      - name: nginx
    +        # Run this image
    +        image: nginx:1.14
    +
    +
    + + + + + +
    GroupVersionKind
    appsv1Deployment
    +
    Appears In: + +
    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object metadata.
    spec
    DeploymentSpec
    Specification of the desired behavior of the Deployment.
    status
    DeploymentStatus
    Most recently observed status of the Deployment.
    +

    DeploymentSpec v1 apps

    +
    Appears In: + +
    + + + + + + + + + + + + +
    FieldDescription
    minReadySeconds
    integer
    Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
    paused
    boolean
    Indicates that the deployment is paused.
    progressDeadlineSeconds
    integer
    The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s.
    replicas
    integer
    Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
    revisionHistoryLimit
    integer
    The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.
    selector
    LabelSelector
    Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. It must match the pod template's labels.
    strategy
    DeploymentStrategy
    patch strategy: retainKeys
    The deployment strategy to use to replace existing pods with new ones.
    template
    PodTemplateSpec
    Template describes the pods that will be created.
    +

    DeploymentStatus v1 apps

    +
    Appears In: + +
    + + + + + + + + + + + + +
    FieldDescription
    availableReplicas
    integer
    Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.
    collisionCount
    integer
    Count of hash collisions for the Deployment. The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet.
    conditions
    DeploymentCondition array
    patch strategy: merge
    patch merge key: type
    Represents the latest available observations of a deployment's current state.
    observedGeneration
    integer
    The generation observed by the deployment controller.
    readyReplicas
    integer
    Total number of ready pods targeted by this deployment.
    replicas
    integer
    Total number of non-terminated pods targeted by this deployment (their labels match the selector).
    unavailableReplicas
    integer
    Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created.
    updatedReplicas
    integer
    Total number of non-terminated pods targeted by this deployment that have the desired template spec.
    +

    DeploymentList v1 apps

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    Deployment array
    Items is the list of Deployments.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata.
    +

    DeploymentStrategy v1 apps

    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    rollingUpdate
    RollingUpdateDeployment
    Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate.
    type
    string
    Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.
    +

    RollingUpdateDeployment v1 apps

    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    maxSurgeThe maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods.
    maxUnavailableThe maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.
    +

    Write Operations

    +

    Create

    + + +
    +
    +
    kubectl command
    +
    +
    
    +$ echo 'apiVersion: apps/v1
    +kind: Deployment
    +metadata:
    +  name: deployment-example
    +spec:
    +  replicas: 3
    +  revisionHistoryLimit: 10
    +  selector:
    +    matchLabels:
    +      app: nginx
    +  template:
    +    metadata:
    +      labels:
    +        app: nginx
    +    spec:
    +      containers:
    +      - name: nginx
    +        image: nginx:1.14
    +        ports:
    +        - containerPort: 80
    +' | kubectl create -f -
    +
    +
    +
    +
    curl command (requires kubectl proxy to be running)
    +
    +
    
    +$ kubectl proxy
    +$ curl -X POST -H 'Content-Type: application/yaml' --data '
    +apiVersion: apps/v1
    +kind: Deployment
    +metadata:
    +  name: deployment-example
    +spec:
    +  replicas: 3
    +  revisionHistoryLimit: 10
    +  selector:
    +    matchLabels:
    +      app: nginx
    +  template:
    +    metadata:
    +      labels:
    +        app: nginx
    +    spec:
    +      containers:
    +      - name: nginx
    +        image: nginx:1.14
    +        ports:
    +        - containerPort: 80
    +' http://127.0.0.1:8001/apis/apps/v1/namespaces/default/deployments
    +
    + + +
    +
    +
    Output
    +
    +
    
    +deployment "deployment-example" created
    +
    +
    +
    +
    Response Body
    +
    +
    
    +{
    +  "kind": "Deployment",
    +  "apiVersion": "apps/v1",
    +  "metadata": {
    +    "name": "deployment-example",
    +    "namespace": "default",
    +    "selfLink": "/apis/apps/v1/namespaces/default/deployments/deployment-example",
    +    "uid": "4ccca349-9cb1-11e6-9c54-42010a800148",
    +    "resourceVersion": "2118306",
    +    "generation": 1,
    +    "creationTimestamp": "2016-10-28T01:53:19Z",
    +    "labels": {
    +      "app": "nginx"
    +    }
    +  },
    +  "spec": {
    +    "replicas": 3,
    +    "selector": {
    +      "matchLabels": {
    +        "app": "nginx"
    +      }
    +    },
    +    "template": {
    +      "metadata": {
    +        "creationTimestamp": null,
    +        "labels": {
    +          "app": "nginx"
    +        }
    +      },
    +      "spec": {
    +        "containers": [
    +          {
    +            "name": "nginx",
    +            "image": "nginx:1.14",
    +            "ports": [
    +              {
    +                "containerPort": 80,
    +                "protocol": "TCP"
    +              }
    +            ],
    +            "resources": {},
    +            "terminationMessagePath": "/dev/termination-log",
    +            "imagePullPolicy": "IfNotPresent"
    +          }
    +        ],
    +        "restartPolicy": "Always",
    +        "terminationGracePeriodSeconds": 30,
    +        "dnsPolicy": "ClusterFirst",
    +        "securityContext": {}
    +      }
    +    },
    +    "strategy": {
    +      "type": "RollingUpdate",
    +      "rollingUpdate": {
    +        "maxUnavailable": 1,
    +        "maxSurge": 1
    +      }
    +    },
    +    "revisionHistoryLimit": 10
    +  },
    +  "status": {}
    +}
    +
    +
    +

    create a Deployment

    +

    HTTP Request

    +POST /apis/apps/v1/namespaces/{namespace}/deployments +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Deployment
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    Deployment
    OK
    201
    Deployment
    Created
    202
    Deployment
    Accepted
    +

    Patch

    + + +
    +
    +
    kubectl command
    +
    +
    
    +$ kubectl patch deployment deployment-example -p \
    +	'{"spec":{"template":{"spec":{"containers":[{"name":"nginx","image":"nginx:1.16"}]}}}}'
    +
    +
    +
    +
    curl command (requires kubectl proxy to be running)
    +
    +
    
    +$ kubectl proxy
    +$ curl -X PATCH -H 'Content-Type: application/strategic-merge-patch+json' --data '
    +{"spec":{"template":{"spec":{"containers":[{"name":"nginx","image":"nginx:1.16"}]}}}}' \
    +	'http://127.0.0.1:8001/apis/apps/v1/namespaces/default/deployments/deployment-example'
    +
    + + +
    +
    +
    Output
    +
    +
    
    +"deployment-example" patched
    +
    +
    +
    +
    Response Body
    +
    +
    
    +{
    +  "kind": "Deployment",
    +  "apiVersion": "apps/v1",
    +  "metadata": {
    +    "name": "deployment-example",
    +    "namespace": "default",
    +    "selfLink": "/apis/apps/v1/namespaces/default/deployments/deployment-example",
    +    "uid": "5dc3a8e6-b0ee-11e6-aef0-42010af00229",
    +    "resourceVersion": "164489",
    +    "generation": 11,
    +    "creationTimestamp": "2016-11-22T20:00:50Z",
    +    "labels": {
    +      "app": "nginx"
    +    },
    +    "annotations": {
    +      "deployment.kubernetes.io/revision": "5"
    +    }
    +  },
    +  "spec": {
    +    "replicas": 3,
    +    "selector": {
    +      "matchLabels": {
    +        "app": "nginx"
    +      }
    +    },
    +    "template": {
    +      "metadata": {
    +        "creationTimestamp": null,
    +        "labels": {
    +          "app": "nginx"
    +        }
    +      },
    +      "spec": {
    +        "containers": [
    +          {
    +            "name": "nginx",
    +            "image": "nginx:1.16",
    +            "ports": [
    +              {
    +                "containerPort": 80,
    +                "protocol": "TCP"
    +              }
    +            ],
    +            "resources": {},
    +            "terminationMessagePath": "/dev/termination-log",
    +            "imagePullPolicy": "IfNotPresent"
    +          }
    +        ],
    +        "restartPolicy": "Always",
    +        "terminationGracePeriodSeconds": 30,
    +        "dnsPolicy": "ClusterFirst",
    +        "securityContext": {}
    +      }
    +    },
    +    "strategy": {
    +      "type": "RollingUpdate",
    +      "rollingUpdate": {
    +        "maxUnavailable": 1,
    +        "maxSurge": 1
    +      }
    +    },
    +    "revisionHistoryLimit": 10
    +  },
    +  "status": {
    +    "observedGeneration": 10,
    +    "replicas": 3,
    +    "updatedReplicas": 3,
    +    "availableReplicas": 3
    +  }
    +}
    +
    +
    +

    partially update the specified Deployment

    +

    HTTP Request

    +PATCH /apis/apps/v1/namespaces/{namespace}/deployments/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Deployment
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    Deployment
    OK
    +

    Replace

    + + +
    +
    +
    kubectl command
    +
    +
    
    +$ echo 'apiVersion: apps/v1
    +kind: Deployment
    +metadata:
    +  name: deployment-example
    +spec:
    +  replicas: 3
    +  revisionHistoryLimit: 10
    +  selector:
    +    matchLabels:
    +      app: nginx
    +  template:
    +    metadata:
    +      labels:
    +        app: nginx
    +    spec:
    +      containers:
    +      - name: nginx
    +        image: nginx:1.16
    +        ports:
    +        - containerPort: 80
    +' | kubectl replace -f -
    +
    +
    +
    +
    curl command (requires kubectl proxy to be running)
    +
    +
    
    +$ kubectl proxy
    +$ curl -X PUT -H 'Content-Type: application/yaml' --data '
    +apiVersion: apps/v1
    +kind: Deployment
    +metadata:
    +  name: deployment-example
    +spec:
    +  replicas: 3
    +  revisionHistoryLimit: 10
    +  selector:
    +    matchLabels:
    +      app: nginx
    +  template:
    +    metadata:
    +      labels:
    +        app: nginx
    +    spec:
    +      containers:
    +      - name: nginx
    +        image: nginx:1.16
    +        ports:
    +        - containerPort: 80
    +' http://127.0.0.1:8001/apis/apps/v1/namespaces/default/deployments/deployment-example
    +
    + + +
    +
    +
    Output
    +
    +
    
    +deployment "deployment-example" replaced
    +
    +
    +
    +
    Response Body
    +
    +
    
    +{
    +  "kind": "Deployment",
    +  "apiVersion": "apps/v1",
    +  "metadata": {
    +    "name": "deployment-example",
    +    "namespace": "default",
    +    "selfLink": "/apis/apps/v1/namespaces/default/deployments/deployment-example",
    +    "uid": "4ccca349-9cb1-11e6-9c54-42010a800148",
    +    "resourceVersion": "2119082",
    +    "generation": 5,
    +    "creationTimestamp": "2016-10-28T01:53:19Z",
    +    "labels": {
    +      "app": "nginx"
    +    }
    +  },
    +  "spec": {
    +    "replicas": 3,
    +    "selector": {
    +      "matchLabels": {
    +        "app": "nginx"
    +      }
    +    },
    +    "template": {
    +      "metadata": {
    +        "creationTimestamp": null,
    +        "labels": {
    +          "app": "nginx"
    +        }
    +      },
    +      "spec": {
    +        "containers": [
    +          {
    +            "name": "nginx",
    +            "image": "nginx:1.16",
    +            "ports": [
    +              {
    +                "containerPort": 80,
    +                "protocol": "TCP"
    +              }
    +            ],
    +            "resources": {},
    +            "terminationMessagePath": "/dev/termination-log",
    +            "imagePullPolicy": "IfNotPresent"
    +          }
    +        ],
    +        "restartPolicy": "Always",
    +        "terminationGracePeriodSeconds": 30,
    +        "dnsPolicy": "ClusterFirst",
    +        "securityContext": {}
    +      }
    +    },
    +    "strategy": {
    +      "type": "RollingUpdate",
    +      "rollingUpdate": {
    +        "maxUnavailable": 1,
    +        "maxSurge": 1
    +      }
    +    },
    +    "revisionHistoryLimit": 10
    +  },
    +  "status": {
    +    "observedGeneration": 4,
    +    "replicas": 3,
    +    "updatedReplicas": 3,
    +    "availableReplicas": 3
    +  }
    +}
    +
    +
    +

    replace the specified Deployment

    +

    HTTP Request

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

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Deployment
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Deployment
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Deployment
    OK
    201
    Deployment
    Created
    +

    Delete

    + + +
    +
    +
    kubectl command
    +
    +
    
    +$ kubectl delete deployment deployment-example
    +
    +
    +
    +
    curl command (requires kubectl proxy to be running)
    +
    +
    
    +$ kubectl proxy
    +$ curl -X DELETE -H 'Content-Type: application/yaml' --data '
    +gracePeriodSeconds: 0
    +orphanDependents: false
    +' 'http://127.0.0.1:8001/apis/apps/v1/namespaces/default/deployments/deployment-example'
    +
    + + +
    +
    +
    Output
    +
    +
    
    +deployment "deployment-example" deleted
    +
    +
    +
    +
    Response Body
    +
    +
    
    +{
    +  "kind": "Status",
    +  "apiVersion": "v1",
    +  "metadata": {},
    +  "status": "Success",
    +  "code": 200
    +}
    +
    +
    +

    delete a Deployment

    +

    HTTP Request

    +DELETE /apis/apps/v1/namespaces/{namespace}/deployments/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Deployment
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of Deployment

    +

    HTTP Request

    +DELETE /apis/apps/v1/namespaces/{namespace}/deployments +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    + + +
    +
    +
    kubectl command
    +
    +
    
    +$ kubectl get deployment deployment-example -o json
    +
    +
    +
    +
    curl command (requires kubectl proxy to be running)
    +
    +
    
    +$ kubectl proxy
    +$ curl -X GET http://127.0.0.1:8001/apis/apps/v1/namespaces/default/deployments/deployment-example
    +
    + + +
    +
    +
    Output
    +
    +
    
    +{
    +  "kind": "Deployment",
    +  "apiVersion": "apps/v1",
    +  "metadata": {
    +    "name": "deployment-example",
    +    "namespace": "default",
    +    "selfLink": "/apis/apps/v1/namespaces/default/deployments/deployment-example",
    +    "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
    +    "resourceVersion": "2064726",
    +    "generation": 4,
    +    "creationTimestamp": "2016-10-27T16:33:35Z",
    +    "labels": {
    +      "app": "nginx"
    +    },
    +    "annotations": {
    +      "deployment.kubernetes.io/revision": "1"
    +    }
    +  },
    +  "spec": {
    +    "replicas": 3,
    +    "selector": {
    +      "matchLabels": {
    +        "app": "nginx"
    +      }
    +    },
    +    "template": {
    +      "metadata": {
    +        "creationTimestamp": null,
    +        "labels": {
    +          "app": "nginx"
    +        }
    +      },
    +      "spec": {
    +        "containers": [
    +          {
    +            "name": "nginx",
    +            "image": "nginx:1.14",
    +            "ports": [
    +              {
    +                "containerPort": 80,
    +                "protocol": "TCP"
    +              }
    +            ],
    +            "resources": {},
    +            "terminationMessagePath": "/dev/termination-log",
    +            "imagePullPolicy": "IfNotPresent"
    +          }
    +        ],
    +        "restartPolicy": "Always",
    +        "terminationGracePeriodSeconds": 30,
    +        "dnsPolicy": "ClusterFirst",
    +        "securityContext": {}
    +      }
    +    },
    +    "strategy": {
    +      "type": "RollingUpdate",
    +      "rollingUpdate": {
    +        "maxUnavailable": 1,
    +        "maxSurge": 1
    +      }
    +    }
    +  },
    +  "status": {
    +    "observedGeneration": 4,
    +    "replicas": 3,
    +    "updatedReplicas": 3,
    +    "availableReplicas": 3
    +  }
    +}
    +
    +
    +
    +
    +
    Response Body
    +
    +
    
    +{
    +  "kind": "Deployment",
    +  "apiVersion": "apps/v1",
    +  "metadata": {
    +    "name": "deployment-example",
    +    "namespace": "default",
    +    "selfLink": "/apis/apps/v1/namespaces/default/deployments/deployment-example",
    +    "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
    +    "resourceVersion": "2064726",
    +    "generation": 4,
    +    "creationTimestamp": "2016-10-27T16:33:35Z",
    +    "labels": {
    +      "app": "nginx"
    +    },
    +    "annotations": {
    +      "deployment.kubernetes.io/revision": "1"
    +    }
    +  },
    +  "spec": {
    +    "replicas": 3,
    +    "selector": {
    +      "matchLabels": {
    +        "app": "nginx"
    +      }
    +    },
    +    "template": {
    +      "metadata": {
    +        "creationTimestamp": null,
    +        "labels": {
    +          "app": "nginx"
    +        }
    +      },
    +      "spec": {
    +        "containers": [
    +          {
    +            "name": "nginx",
    +            "image": "nginx:1.14",
    +            "ports": [
    +              {
    +                "containerPort": 80,
    +                "protocol": "TCP"
    +              }
    +            ],
    +            "resources": {},
    +            "terminationMessagePath": "/dev/termination-log",
    +            "imagePullPolicy": "IfNotPresent"
    +          }
    +        ],
    +        "restartPolicy": "Always",
    +        "terminationGracePeriodSeconds": 30,
    +        "dnsPolicy": "ClusterFirst",
    +        "securityContext": {}
    +      }
    +    },
    +    "strategy": {
    +      "type": "RollingUpdate",
    +      "rollingUpdate": {
    +        "maxUnavailable": 1,
    +        "maxSurge": 1
    +      }
    +    }
    +  },
    +  "status": {
    +    "observedGeneration": 4,
    +    "replicas": 3,
    +    "updatedReplicas": 3,
    +    "availableReplicas": 3
    +  }
    +}
    +
    +
    +

    read the specified Deployment

    +

    HTTP Request

    +GET /apis/apps/v1/namespaces/{namespace}/deployments/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Deployment
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    Deployment
    OK
    +

    List

    + + +
    +
    +
    kubectl command
    +
    +
    
    +$ kubectl get deployment -o json
    +
    +
    +
    +
    curl command (requires kubectl proxy to be running)
    +
    +
    
    +$ kubectl proxy
    +$ curl -X GET 'http://127.0.0.1:8001/apis/apps/v1/namespaces/default/deployments'
    +
    + + +
    +
    +
    Output
    +
    +
    
    +{
    +  "kind": "List",
    +  "apiVersion": "v1",
    +  "metadata": {},
    +  "items": [
    +    {
    +      "kind": "Deployment",
    +      "apiVersion": "app/v1beta1",
    +      "metadata": {
    +        "name": "docs",
    +        "namespace": "default",
    +        "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/docs",
    +        "uid": "ef49e1d2-915e-11e6-be81-42010a80003f",
    +        "resourceVersion": "1924126",
    +        "generation": 21,
    +        "creationTimestamp": "2016-10-13T16:06:00Z",
    +        "labels": {
    +          "run": "docs"
    +        },
    +        "annotations": {
    +          "deployment.kubernetes.io/revision": "10",
    +          "replicatingperfection.net/push-image": "true"
    +        }
    +      },
    +      "spec": {
    +        "replicas": 1,
    +        "selector": {
    +          "matchLabels": {
    +            "run": "docs"
    +          }
    +        },
    +        "template": {
    +          "metadata": {
    +            "creationTimestamp": null,
    +            "labels": {
    +              "auto-pushed-image-pwittrock/api-docs": "1477496453",
    +              "run": "docs"
    +            }
    +          },
    +          "spec": {
    +            "containers": [
    +              {
    +                "name": "docs",
    +                "image": "pwittrock/api-docs:v9",
    +                "resources": {},
    +                "terminationMessagePath": "/dev/termination-log",
    +                "imagePullPolicy": "Always"
    +              }
    +            ],
    +            "restartPolicy": "Always",
    +            "terminationGracePeriodSeconds": 30,
    +            "dnsPolicy": "ClusterFirst",
    +            "securityContext": {}
    +          }
    +        },
    +        "strategy": {
    +          "type": "RollingUpdate",
    +          "rollingUpdate": {
    +            "maxUnavailable": 1,
    +            "maxSurge": 1
    +          }
    +        }
    +      },
    +      "status": {
    +        "observedGeneration": 21,
    +        "replicas": 1,
    +        "updatedReplicas": 1,
    +        "availableReplicas": 1
    +      }
    +    },
    +    {
    +      "kind": "Deployment",
    +      "apiVersion": "app/v1beta1",
    +      "metadata": {
    +        "name": "deployment-example",
    +        "namespace": "default",
    +        "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/deployment-example",
    +        "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
    +        "resourceVersion": "2064726",
    +        "generation": 4,
    +        "creationTimestamp": "2016-10-27T16:33:35Z",
    +        "labels": {
    +          "app": "nginx"
    +        },
    +        "annotations": {
    +          "deployment.kubernetes.io/revision": "1"
    +        }
    +      },
    +      "spec": {
    +        "replicas": 3,
    +        "selector": {
    +          "matchLabels": {
    +            "app": "nginx"
    +          }
    +        },
    +        "template": {
    +          "metadata": {
    +            "creationTimestamp": null,
    +            "labels": {
    +              "app": "nginx"
    +            }
    +          },
    +          "spec": {
    +            "containers": [
    +              {
    +                "name": "nginx",
    +                "image": "nginx:1.14",
    +                "ports": [
    +                  {
    +                    "containerPort": 80,
    +                    "protocol": "TCP"
    +                  }
    +                ],
    +                "resources": {},
    +                "terminationMessagePath": "/dev/termination-log",
    +                "imagePullPolicy": "IfNotPresent"
    +              }
    +            ],
    +            "restartPolicy": "Always",
    +            "terminationGracePeriodSeconds": 30,
    +            "dnsPolicy": "ClusterFirst",
    +            "securityContext": {}
    +          }
    +        },
    +        "strategy": {
    +          "type": "RollingUpdate",
    +          "rollingUpdate": {
    +            "maxUnavailable": 1,
    +            "maxSurge": 1
    +          }
    +        }
    +      },
    +      "status": {
    +        "observedGeneration": 4,
    +        "replicas": 3,
    +        "updatedReplicas": 3,
    +        "availableReplicas": 3
    +      }
    +    }
    +  ]
    +}
    +
    +
    +
    +
    +
    Response Body
    +
    +
    
    +{
    +  "kind": "List",
    +  "apiVersion": "v1",
    +  "metadata": {},
    +  "items": [
    +    {
    +      "kind": "Deployment",
    +      "apiVersion": "app/v1beta1",
    +      "metadata": {
    +        "name": "docs",
    +        "namespace": "default",
    +        "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/docs",
    +        "uid": "ef49e1d2-915e-11e6-be81-42010a80003f",
    +        "resourceVersion": "1924126",
    +        "generation": 21,
    +        "creationTimestamp": "2016-10-13T16:06:00Z",
    +        "labels": {
    +          "run": "docs"
    +        },
    +        "annotations": {
    +          "deployment.kubernetes.io/revision": "10",
    +          "replicatingperfection.net/push-image": "true"
    +        }
    +      },
    +      "spec": {
    +        "replicas": 1,
    +        "selector": {
    +          "matchLabels": {
    +            "run": "docs"
    +          }
    +        },
    +        "template": {
    +          "metadata": {
    +            "creationTimestamp": null,
    +            "labels": {
    +              "auto-pushed-image-pwittrock/api-docs": "1477496453",
    +              "run": "docs"
    +            }
    +          },
    +          "spec": {
    +            "containers": [
    +              {
    +                "name": "docs",
    +                "image": "pwittrock/api-docs:v9",
    +                "resources": {},
    +                "terminationMessagePath": "/dev/termination-log",
    +                "imagePullPolicy": "Always"
    +              }
    +            ],
    +            "restartPolicy": "Always",
    +            "terminationGracePeriodSeconds": 30,
    +            "dnsPolicy": "ClusterFirst",
    +            "securityContext": {}
    +          }
    +        },
    +        "strategy": {
    +          "type": "RollingUpdate",
    +          "rollingUpdate": {
    +            "maxUnavailable": 1,
    +            "maxSurge": 1
    +          }
    +        }
    +      },
    +      "status": {
    +        "observedGeneration": 21,
    +        "replicas": 1,
    +        "updatedReplicas": 1,
    +        "availableReplicas": 1
    +      }
    +    },
    +    {
    +      "kind": "Deployment",
    +      "apiVersion": "app/v1beta1",
    +      "metadata": {
    +        "name": "deployment-example",
    +        "namespace": "default",
    +        "selfLink": "/apis/app/v1beta1/namespaces/default/deployments/deployment-example",
    +        "uid": "1b33145a-9c63-11e6-9c54-42010a800148",
    +        "resourceVersion": "2064726",
    +        "generation": 4,
    +        "creationTimestamp": "2016-10-27T16:33:35Z",
    +        "labels": {
    +          "app": "nginx"
    +        },
    +        "annotations": {
    +          "deployment.kubernetes.io/revision": "1"
    +        }
    +      },
    +      "spec": {
    +        "replicas": 3,
    +        "selector": {
    +          "matchLabels": {
    +            "app": "nginx"
    +          }
    +        },
    +        "template": {
    +          "metadata": {
    +            "creationTimestamp": null,
    +            "labels": {
    +              "app": "nginx"
    +            }
    +          },
    +          "spec": {
    +            "containers": [
    +              {
    +                "name": "nginx",
    +                "image": "nginx:1.14",
    +                "ports": [
    +                  {
    +                    "containerPort": 80,
    +                    "protocol": "TCP"
    +                  }
    +                ],
    +                "resources": {},
    +                "terminationMessagePath": "/dev/termination-log",
    +                "imagePullPolicy": "IfNotPresent"
    +              }
    +            ],
    +            "restartPolicy": "Always",
    +            "terminationGracePeriodSeconds": 30,
    +            "dnsPolicy": "ClusterFirst",
    +            "securityContext": {}
    +          }
    +        },
    +        "strategy": {
    +          "type": "RollingUpdate",
    +          "rollingUpdate": {
    +            "maxUnavailable": 1,
    +            "maxSurge": 1
    +          }
    +        }
    +      },
    +      "status": {
    +        "observedGeneration": 4,
    +        "replicas": 3,
    +        "updatedReplicas": 3,
    +        "availableReplicas": 3
    +      }
    +    }
    +  ]
    +}
    +
    +
    +

    list or watch objects of kind Deployment

    +

    HTTP Request

    +GET /apis/apps/v1/namespaces/{namespace}/deployments +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    DeploymentList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind Deployment

    +

    HTTP Request

    +GET /apis/apps/v1/deployments +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    DeploymentList
    OK
    +

    Watch

    + + +
    +
    +
    kubectl command
    +
    +
    
    +$ kubectl get deployment deployment-example --watch -o json
    +
    +
    +
    +
    curl command (requires kubectl proxy to be running)
    +
    +
    
    +$ kubectl proxy
    +$ curl -X GET 'http://127.0.0.1:8001/apis/apps/v1/watch/namespaces/default/deployments/deployment-example'
    +
    + + +
    +
    +
    Output
    +
    +
    
    +{
    +	"type": "ADDED",
    +	"object": {
    +		"kind": "Deployment",
    +		"apiVersion": "apps/v1",
    +		"metadata": {
    +			"name": "deployment-example",
    +			"namespace": "default",
    +			"selfLink": "/apis/apps/v1/namespaces/default/deployments/deployment-example",
    +			"uid": "64c12290-9cbf-11e6-9c54-42010a800148",
    +			"resourceVersion": "2128095",
    +			"generation": 2,
    +			"creationTimestamp": "2016-10-28T03:34:12Z",
    +			"labels": {
    +				"app": "nginx"
    +			},
    +			"annotations": {
    +				"deployment.kubernetes.io/revision": "3"
    +			}
    +		},
    +		"spec": {
    +			"replicas": 3,
    +			"selector": {
    +				"matchLabels": {
    +					"app": "nginx"
    +				}
    +			},
    +			"template": {
    +				"metadata": {
    +					"creationTimestamp": null,
    +					"labels": {
    +						"app": "nginx"
    +					}
    +				},
    +				"spec": {
    +					"containers": [
    +						{
    +							"name": "nginx",
    +							"image": "nginx:1.14",
    +							"ports": [
    +								{
    +									"containerPort": 80,
    +									"protocol": "TCP"
    +								}
    +							],
    +							"resources": {
    +							},
    +							"terminationMessagePath": "/dev/termination-log",
    +							"imagePullPolicy": "IfNotPresent"
    +						}
    +					],
    +					"restartPolicy": "Always",
    +					"terminationGracePeriodSeconds": 30,
    +					"dnsPolicy": "ClusterFirst",
    +					"securityContext": {
    +					}
    +				}
    +			},
    +			"strategy": {
    +				"type": "RollingUpdate",
    +				"rollingUpdate": {
    +					"maxUnavailable": 1,
    +					"maxSurge": 1
    +				}
    +			}
    +		},
    +		"status": {
    +			"observedGeneration": 2,
    +			"replicas": 3,
    +			"updatedReplicas": 3,
    +			"availableReplicas": 3
    +		}
    +	}
    +}
    +
    +
    +
    +
    +
    Response Body
    +
    +
    
    +{
    +	"type": "ADDED",
    +	"object": {
    +		"kind": "Deployment",
    +		"apiVersion": "apps/v1",
    +		"metadata": {
    +			"name": "deployment-example",
    +			"namespace": "default",
    +			"selfLink": "/apis/apps/v1/namespaces/default/deployments/deployment-example",
    +			"uid": "64c12290-9cbf-11e6-9c54-42010a800148",
    +			"resourceVersion": "2128095",
    +			"generation": 2,
    +			"creationTimestamp": "2016-10-28T03:34:12Z",
    +			"labels": {
    +				"app": "nginx"
    +			},
    +			"annotations": {
    +				"deployment.kubernetes.io/revision": "3"
    +			}
    +		},
    +		"spec": {
    +			"replicas": 3,
    +			"selector": {
    +				"matchLabels": {
    +					"app": "nginx"
    +				}
    +			},
    +			"template": {
    +				"metadata": {
    +					"creationTimestamp": null,
    +					"labels": {
    +						"app": "nginx"
    +					}
    +				},
    +				"spec": {
    +					"containers": [
    +						{
    +							"name": "nginx",
    +							"image": "nginx:1.14",
    +							"ports": [
    +								{
    +									"containerPort": 80,
    +									"protocol": "TCP"
    +								}
    +							],
    +							"resources": {
    +							},
    +							"terminationMessagePath": "/dev/termination-log",
    +							"imagePullPolicy": "IfNotPresent"
    +						}
    +					],
    +					"restartPolicy": "Always",
    +					"terminationGracePeriodSeconds": 30,
    +					"dnsPolicy": "ClusterFirst",
    +					"securityContext": {
    +					}
    +				}
    +			},
    +			"strategy": {
    +				"type": "RollingUpdate",
    +				"rollingUpdate": {
    +					"maxUnavailable": 1,
    +					"maxSurge": 1
    +				}
    +			}
    +		},
    +		"status": {
    +			"observedGeneration": 2,
    +			"replicas": 3,
    +			"updatedReplicas": 3,
    +			"availableReplicas": 3
    +		}
    +	}
    +}
    +
    +
    +

    watch changes to an object of kind Deployment. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/apps/v1/watch/namespaces/{namespace}/deployments/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Deployment
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of Deployment. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/apps/v1/watch/namespaces/{namespace}/deployments +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of Deployment. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/apps/v1/watch/deployments +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Status Operations

    +

    Patch Status

    +

    partially update status of the specified Deployment

    +

    HTTP Request

    +PATCH /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Deployment
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    Deployment
    OK
    +

    Read Status

    +

    read status of the specified Deployment

    +

    HTTP Request

    +GET /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Deployment
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    Deployment
    OK
    +

    Replace Status

    +

    replace status of the specified Deployment

    +

    HTTP Request

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

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Deployment
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Deployment
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Deployment
    OK
    201
    Deployment
    Created
    +

    Misc Operations

    +

    Read Scale

    +

    read scale of the specified Deployment

    +

    HTTP Request

    +GET /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Scale
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    Scale
    OK
    +

    Replace Scale

    +

    replace scale of the specified Deployment

    +

    HTTP Request

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

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Scale
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Scale
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Scale
    OK
    201
    Scale
    Created
    +

    Patch Scale

    +

    partially update scale of the specified Deployment

    +

    HTTP Request

    +PATCH /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Scale
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    Scale
    OK
    +

    Job v1 batch

    + +
    +
    +
    Job Config to print pi up to 2000 digits (then exit).
    +
    +
    
    +apiVersion: batch/v1
    +kind: Job
    +metadata:
    +  # Unique key of the Job instance
    +  name: example-job
    +spec:
    +  template:
    +    metadata:
    +      name: example-job
    +    spec:
    +      containers:
    +      - name: pi
    +        image: perl
    +        command: ["perl"]
    +        args: ["-Mbignum=bpi", "-wle", "print bpi(2000)"]
    +      # Do not restart containers after they exit
    +      restartPolicy: Never
    +
    +
    + + + + + +
    GroupVersionKind
    batchv1Job
    +
    Appears In: + +
    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    spec
    JobSpec
    Specification of the desired behavior of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    status
    JobStatus
    Current status of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    +

    JobSpec v1 batch

    + + + + + + + + + + + + + + + +
    FieldDescription
    activeDeadlineSeconds
    integer
    Specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it; value must be positive integer. If a Job is suspended (at creation or through an update), this timer will effectively be stopped and reset when the Job is resumed again.
    backoffLimit
    integer
    Specifies the number of retries before marking this job failed. Defaults to 6
    completionMode
    string
    CompletionMode specifies how Pod completions are tracked. It can be `NonIndexed` (default) or `Indexed`. `NonIndexed` means that the Job is considered complete when there have been .spec.completions successfully completed Pods. Each Pod completion is homologous to each other. `Indexed` means that the Pods of a Job get an associated completion index from 0 to (.spec.completions - 1), available in the annotation batch.kubernetes.io/job-completion-index. The Job is considered complete when there is one successfully completed Pod for each index. When value is `Indexed`, .spec.completions must be specified and `.spec.parallelism` must be less than or equal to 10^5. This field is alpha-level and is only honored by servers that enable the IndexedJob feature gate. More completion modes can be added in the future. If the Job controller observes a mode that it doesn't recognize, the controller skips updates for the Job.
    completions
    integer
    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/
    manualSelector
    boolean
    manualSelector controls generation of pod labels and pod selectors. Leave `manualSelector` unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see `manualSelector=true` in jobs that were created with the old `extensions/v1beta1` API. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/#specifying-your-own-pod-selector
    parallelism
    integer
    Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
    selector
    LabelSelector
    A label query over pods that should match the pod count. Normally, the system sets this field for you. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
    suspend
    boolean
    Suspend specifies whether the Job controller should create Pods or not. If a Job is created with suspend set to true, no Pods are created by the Job controller. If a Job is suspended after creation (i.e. the flag goes from false to true), the Job controller will delete all active Pods associated with this Job. Users must design their workload to gracefully handle this. Suspending a Job will reset the StartTime field of the Job, effectively resetting the ActiveDeadlineSeconds timer too. This is an alpha field and requires the SuspendJob feature gate to be enabled; otherwise this field may not be set to true. Defaults to false.
    template
    PodTemplateSpec
    Describes the pod that will be created when executing a job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
    ttlSecondsAfterFinished
    integer
    ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is unset, the Job won't be automatically deleted. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes. This field is alpha-level and is only honored by servers that enable the TTLAfterFinished feature.
    +

    JobStatus v1 batch

    +
    Appears In: + +
    + + + + + + + + + + + +
    FieldDescription
    active
    integer
    The number of actively running pods.
    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".
    completionTime
    Time
    Represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. The completion time is only set when the job finishes successfully.
    conditions
    JobCondition array
    patch strategy: merge
    patch merge key: type
    The latest available observations of an object's current state. When a Job fails, one of the conditions will have type "Failed" and status true. When a Job is suspended, one of the conditions will have type "Suspended" and status true; when the Job is resumed, the status of this condition will become false. When a Job is completed, one of the conditions will have type "Complete" and status true. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
    failed
    integer
    The number of pods which reached phase Failed.
    startTime
    Time
    Represents time when the job controller started processing a job. When a Job is created in the suspended state, this field is not set until the first time it is resumed. This field is reset every time a Job is resumed from suspension. It is represented in RFC3339 form and is in UTC.
    succeeded
    integer
    The number of pods which reached phase Succeeded.
    +

    JobList v1 batch

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    Job array
    items is the list of Jobs.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    +

    Write Operations

    +

    Create

    + + +
    +
    +
    kubectl command
    +
    +
    
    +$ echo 'apiVersion: batch/v1
    +kind: Job
    +metadata:
    +  name: example-job
    +spec:
    +  template:
    +    metadata:
    +      name: example-job
    +    spec:
    +      containers:
    +      - name: pi
    +        image: perl
    +        command: ["perl",  "-Mbignum=bpi", "-wle", "print bpi(2000)"]
    +      restartPolicy: Never
    +' | kubectl create -f -
    +
    +
    +
    +
    curl command (requires kubectl proxy to be running)
    +
    +
    
    +$ kubectl proxy
    +$ curl -X POST -H 'Content-Type: application/yaml' --data '
    +apiVersion: batch/v1
    +kind: Job
    +metadata:
    +  name: example-job
    +spec:
    +  template:
    +    metadata:
    +      name: example-job
    +    spec:
    +      containers:
    +      - name: pi
    +        image: perl
    +        command: ["perl",  "-Mbignum=bpi", "-wle", "print bpi(2000)"]
    +      restartPolicy: Never
    +' http://127.0.0.1:8001/apis/batch/v1/namespaces/default/jobs
    +
    + + +
    +
    +
    Output
    +
    +
    
    +job "example-job" created
    +
    +
    +
    +
    Response Body
    +
    +
    
    +{
    +  "kind": "Job",
    +  "apiVersion": "batch/v1",
    +  "metadata": {
    +    "name": "example-job",
    +    "namespace": "default",
    +    "selfLink": "/apis/batch/v1/namespaces/default/jobs/example-job",
    +    "uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
    +    "resourceVersion": "7479",
    +    "creationTimestamp": "2016-11-04T18:45:25Z"
    +  },
    +  "spec": {
    +    "parallelism": 1,
    +    "completions": 1,
    +    "selector": {
    +      "matchLabels": {
    +        "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
    +      }
    +    },
    +    "template": {
    +      "metadata": {
    +        "name": "example-job",
    +        "creationTimestamp": null,
    +        "labels": {
    +          "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
    +          "job-name": "example-job"
    +        }
    +      },
    +      "spec": {
    +        "containers": [
    +          {
    +            "name": "pi",
    +            "image": "perl",
    +            "command": [
    +              "perl",
    +              "-Mbignum=bpi",
    +              "-wle",
    +              "print bpi(2000)"
    +            ],
    +            "resources": {},
    +            "terminationMessagePath": "/dev/termination-log",
    +            "imagePullPolicy": "Always"
    +          }
    +        ],
    +        "restartPolicy": "Never",
    +        "terminationGracePeriodSeconds": 30,
    +        "dnsPolicy": "ClusterFirst",
    +        "securityContext": {}
    +      }
    +    }
    +  },
    +  "status": {}
    +}
    +
    +

    create a Job

    +

    HTTP Request

    +POST /apis/batch/v1/namespaces/{namespace}/jobs +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Job
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    Job
    OK
    201
    Job
    Created
    202
    Job
    Accepted
    +

    Patch

    +

    partially update the specified Job

    +

    HTTP Request

    +PATCH /apis/batch/v1/namespaces/{namespace}/jobs/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Job
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    Job
    OK
    +

    Replace

    +

    replace the specified Job

    +

    HTTP Request

    +PUT /apis/batch/v1/namespaces/{namespace}/jobs/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Job
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Job
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Job
    OK
    201
    Job
    Created
    +

    Delete

    + + +
    +
    +
    kubectl command
    +
    +
    
    +$ kubectl delete job example-job
    +
    +
    +
    +
    curl command (requires kubectl proxy to be running)
    +
    +
    
    +$ kubectl proxy
    +$ curl -X DELETE -H 'Content-Type: application/yaml' --data '
    +gracePeriodSeconds: 0
    +orphanDependents: false
    +' 'http://127.0.0.1:8001/apis/batch/v1/namespaces/default/jobs/example-job'
    +
    + + +
    +
    +
    Output
    +
    +
    
    +job "example-job" deleted
    +
    +
    +
    +
    Response Body
    +
    +
    
    +{
    +  "kind": "Status",
    +  "apiVersion": "v1",
    +  "metadata": {},
    +  "status": "Success",
    +  "code": 200
    +}
    +
    +
    +

    delete a Job

    +

    HTTP Request

    +DELETE /apis/batch/v1/namespaces/{namespace}/jobs/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Job
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of Job

    +

    HTTP Request

    +DELETE /apis/batch/v1/namespaces/{namespace}/jobs +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    + + +
    +
    +
    kubectl command
    +
    +
    
    +$ kubectl get job example-job -o json
    +
    +
    +
    +
    curl command (requires kubectl proxy to be running)
    +
    +
    
    +$ kubectl proxy
    +$ curl -X GET http://127.0.0.1:8001/apis/batch/v1/namespaces/default/jobs/example-job
    +
    + + +
    +
    +
    Output
    +
    +
    
    +{
    +  "kind": "Job",
    +  "apiVersion": "batch/v1",
    +  "metadata": {
    +    "name": "example-job",
    +    "namespace": "default",
    +    "selfLink": "/apis/batch/v1/namespaces/default/jobs/example-job",
    +    "uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
    +    "resourceVersion": "7482",
    +    "creationTimestamp": "2016-11-04T18:45:25Z"
    +  },
    +  "spec": {
    +    "parallelism": 1,
    +    "completions": 1,
    +    "selector": {
    +      "matchLabels": {
    +        "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
    +      }
    +    },
    +    "template": {
    +      "metadata": {
    +        "name": "example-job",
    +        "creationTimestamp": null,
    +        "labels": {
    +          "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
    +          "job-name": "example-job"
    +        }
    +      },
    +      "spec": {
    +        "containers": [
    +          {
    +            "name": "pi",
    +            "image": "perl",
    +            "command": [
    +              "perl",
    +              "-Mbignum=bpi",
    +              "-wle",
    +              "print bpi(2000)"
    +            ],
    +            "resources": {},
    +            "terminationMessagePath": "/dev/termination-log",
    +            "imagePullPolicy": "Always"
    +          }
    +        ],
    +        "restartPolicy": "Never",
    +        "terminationGracePeriodSeconds": 30,
    +        "dnsPolicy": "ClusterFirst",
    +        "securityContext": {}
    +      }
    +    }
    +  },
    +  "status": {
    +    "startTime": "2016-11-04T18:45:25Z",
    +    "active": 1
    +  }
    +}
    +
    +
    +
    +
    Response Body
    +
    +
    
    +{
    +  "kind": "Job",
    +  "apiVersion": "batch/v1",
    +  "metadata": {
    +    "name": "example-job",
    +    "namespace": "default",
    +    "selfLink": "/apis/batch/v1/namespaces/default/jobs/example-job",
    +    "uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
    +    "resourceVersion": "7482",
    +    "creationTimestamp": "2016-11-04T18:45:25Z"
    +  },
    +  "spec": {
    +    "parallelism": 1,
    +    "completions": 1,
    +    "selector": {
    +      "matchLabels": {
    +        "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
    +      }
    +    },
    +    "template": {
    +      "metadata": {
    +        "name": "example-job",
    +        "creationTimestamp": null,
    +        "labels": {
    +          "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
    +          "job-name": "example-job"
    +        }
    +      },
    +      "spec": {
    +        "containers": [
    +          {
    +            "name": "pi",
    +            "image": "perl",
    +            "command": [
    +              "perl",
    +              "-Mbignum=bpi",
    +              "-wle",
    +              "print bpi(2000)"
    +            ],
    +            "resources": {},
    +            "terminationMessagePath": "/dev/termination-log",
    +            "imagePullPolicy": "Always"
    +          }
    +        ],
    +        "restartPolicy": "Never",
    +        "terminationGracePeriodSeconds": 30,
    +        "dnsPolicy": "ClusterFirst",
    +        "securityContext": {}
    +      }
    +    }
    +  },
    +  "status": {
    +    "startTime": "2016-11-04T18:45:25Z",
    +    "active": 1
    +  }
    +}
    +
    +

    read the specified Job

    +

    HTTP Request

    +GET /apis/batch/v1/namespaces/{namespace}/jobs/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Job
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    Job
    OK
    +

    List

    + + +
    +
    +
    kubectl command
    +
    +
    
    +$ kubectl get job -o json
    +
    +
    +
    +
    curl command (requires kubectl proxy to be running)
    +
    +
    
    +$ kubectl proxy
    +$ curl -X GET 'http://127.0.0.1:8001/apis/batch/v1/namespaces/default/jobs'
    +
    + + +
    +
    +
    Output
    +
    +
    
    +{
    +  "kind": "JobList",
    +  "apiVersion": "batch/v1",
    +  "metadata": {
    +    "selfLink": "/apis/batch/v1/namespaces/default/jobs",
    +    "resourceVersion": "7589"
    +  },
    +  "items": [
    +    {
    +      "metadata": {
    +        "name": "",
    +        "namespace": "default",
    +        "selfLink": "/apis/batch/v1/namespaces/default/jobs/",
    +        "uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
    +        "resourceVersion": "7482",
    +        "creationTimestamp": "2016-11-04T18:45:25Z"
    +      },
    +      "spec": {
    +        "parallelism": 1,
    +        "completions": 1,
    +        "selector": {
    +          "matchLabels": {
    +            "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
    +          }
    +        },
    +        "template": {
    +          "metadata": {
    +            "name": "",
    +            "creationTimestamp": null,
    +            "labels": {
    +              "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
    +              "job-name": ""
    +            }
    +          },
    +          "spec": {
    +            "containers": [
    +              {
    +                "name": "pi",
    +                "image": "perl",
    +                "command": [
    +                  "perl",
    +                  "-Mbignum=bpi",
    +                  "-wle",
    +                  "print bpi(2000)"
    +                ],
    +                "resources": {},
    +                "terminationMessagePath": "/dev/termination-log",
    +                "imagePullPolicy": "Always"
    +              }
    +            ],
    +            "restartPolicy": "Never",
    +            "terminationGracePeriodSeconds": 30,
    +            "dnsPolicy": "ClusterFirst",
    +            "securityContext": {}
    +          }
    +        }
    +      },
    +      "status": {
    +        "startTime": "2016-11-04T18:45:25Z",
    +        "active": 1
    +      }
    +    }
    +  ]
    +}
    +
    +
    +
    +
    Response Body
    +
    +
    
    +{
    +  "kind": "JobList",
    +  "apiVersion": "batch/v1",
    +  "metadata": {
    +    "selfLink": "/apis/batch/v1/namespaces/default/jobs",
    +    "resourceVersion": "7589"
    +  },
    +  "items": [
    +    {
    +      "metadata": {
    +        "name": "",
    +        "namespace": "default",
    +        "selfLink": "/apis/batch/v1/namespaces/default/jobs/",
    +        "uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
    +        "resourceVersion": "7482",
    +        "creationTimestamp": "2016-11-04T18:45:25Z"
    +      },
    +      "spec": {
    +        "parallelism": 1,
    +        "completions": 1,
    +        "selector": {
    +          "matchLabels": {
    +            "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
    +          }
    +        },
    +        "template": {
    +          "metadata": {
    +            "name": "",
    +            "creationTimestamp": null,
    +            "labels": {
    +              "controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
    +              "job-name": ""
    +            }
    +          },
    +          "spec": {
    +            "containers": [
    +              {
    +                "name": "pi",
    +                "image": "perl",
    +                "command": [
    +                  "perl",
    +                  "-Mbignum=bpi",
    +                  "-wle",
    +                  "print bpi(2000)"
    +                ],
    +                "resources": {},
    +                "terminationMessagePath": "/dev/termination-log",
    +                "imagePullPolicy": "Always"
    +              }
    +            ],
    +            "restartPolicy": "Never",
    +            "terminationGracePeriodSeconds": 30,
    +            "dnsPolicy": "ClusterFirst",
    +            "securityContext": {}
    +          }
    +        }
    +      },
    +      "status": {
    +        "startTime": "2016-11-04T18:45:25Z",
    +        "active": 1
    +      }
    +    }
    +  ]
    +}
    +
    +

    list or watch objects of kind Job

    +

    HTTP Request

    +GET /apis/batch/v1/namespaces/{namespace}/jobs +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    JobList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind Job

    +

    HTTP Request

    +GET /apis/batch/v1/jobs +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    JobList
    OK
    +

    Watch

    + + +
    +
    +
    kubectl command
    +
    +
    
    +$ kubectl get job example-job --watch -o json
    +
    +
    +
    +
    curl command (requires kubectl proxy to be running)
    +
    +
    
    +$ kubectl proxy
    +$ curl -X GET 'http://127.0.0.1:8001/apis/batch/v1/watch/namespaces/default/jobs/example-job'
    +
    + + +
    +
    +
    Output
    +
    +
    
    +{
    +	"type": "ADDED",
    +	"object": {
    +		"kind": "Job",
    +		"apiVersion": "batch/v1",
    +		"metadata": {
    +			"name": "example-job",
    +			"namespace": "default",
    +			"selfLink": "/apis/batch/v1/namespaces/default/jobs/example-job",
    +			"uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
    +			"resourceVersion": "7482",
    +			"creationTimestamp": "2016-11-04T18:45:25Z"
    +		},
    +		"spec": {
    +			"parallelism": 1,
    +			"completions": 1,
    +			"selector": {
    +				"matchLabels": {
    +					"controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
    +				}
    +			},
    +			"template": {
    +				"metadata": {
    +					"name": "example-job",
    +					"creationTimestamp": null,
    +					"labels": {
    +						"controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
    +						"job-name": "example-job"
    +					}
    +				},
    +				"spec": {
    +					"containers": [
    +						{
    +							"name": "pi",
    +							"image": "perl",
    +							"command": [
    +								"perl",
    +								"-Mbignum=bpi",
    +								"-wle",
    +								"print bpi(2000)"
    +							],
    +							"resources": {
    +							},
    +							"terminationMessagePath": "/dev/termination-log",
    +							"imagePullPolicy": "Always"
    +						}
    +					],
    +					"restartPolicy": "Never",
    +					"terminationGracePeriodSeconds": 30,
    +					"dnsPolicy": "ClusterFirst",
    +					"securityContext": {
    +					}
    +				}
    +			}
    +		},
    +		"status": {
    +			"startTime": "2016-11-04T18:45:25Z",
    +			"active": 1
    +		}
    +	}
    +}
    +
    +
    +
    +
    Response Body
    +
    +
    
    +{
    +	"type": "ADDED",
    +	"object": {
    +		"kind": "Job",
    +		"apiVersion": "batch/v1",
    +		"metadata": {
    +			"name": "example-job",
    +			"namespace": "default",
    +			"selfLink": "/apis/batch/v1/namespaces/default/jobs/example-job",
    +			"uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
    +			"resourceVersion": "7482",
    +			"creationTimestamp": "2016-11-04T18:45:25Z"
    +		},
    +		"spec": {
    +			"parallelism": 1,
    +			"completions": 1,
    +			"selector": {
    +				"matchLabels": {
    +					"controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
    +				}
    +			},
    +			"template": {
    +				"metadata": {
    +					"name": "example-job",
    +					"creationTimestamp": null,
    +					"labels": {
    +						"controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
    +						"job-name": "example-job"
    +					}
    +				},
    +				"spec": {
    +					"containers": [
    +						{
    +							"name": "pi",
    +							"image": "perl",
    +							"command": [
    +								"perl",
    +								"-Mbignum=bpi",
    +								"-wle",
    +								"print bpi(2000)"
    +							],
    +							"resources": {
    +							},
    +							"terminationMessagePath": "/dev/termination-log",
    +							"imagePullPolicy": "Always"
    +						}
    +					],
    +					"restartPolicy": "Never",
    +					"terminationGracePeriodSeconds": 30,
    +					"dnsPolicy": "ClusterFirst",
    +					"securityContext": {
    +					}
    +				}
    +			}
    +		},
    +		"status": {
    +			"startTime": "2016-11-04T18:45:25Z",
    +			"active": 1
    +		}
    +	}
    +}
    +
    +

    watch changes to an object of kind Job. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/batch/v1/watch/namespaces/{namespace}/jobs/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Job
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of Job. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/batch/v1/watch/namespaces/{namespace}/jobs +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of Job. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/batch/v1/watch/jobs +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Status Operations

    +

    Patch Status

    +

    partially update status of the specified Job

    +

    HTTP Request

    +PATCH /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Job
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    Job
    OK
    +

    Read Status

    +

    read status of the specified Job

    +

    HTTP Request

    +GET /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Job
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    Job
    OK
    +

    Replace Status

    +

    replace status of the specified Job

    +

    HTTP Request

    +PUT /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Job
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Job
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Job
    OK
    201
    Job
    Created
    +

    Pod v1 core

    + +
    +
    +
    Pod Config to print "Hello World".
    +
    +
    
    +apiVersion: v1
    +kind: Pod
    +metadata:
    +  name: pod-example
    +spec:
    +  containers:
    +  - name: ubuntu
    +    image: ubuntu:trusty
    +    command: ["echo"]
    +    args: ["Hello World"]
    +
    +
    + + + + + +
    GroupVersionKind
    corev1Pod
    +

    Warning:

    It is recommended that users create Pods only through a Controller, and not directly. See Controllers: Deployment, Job, or StatefulSet.

    +
    Appears In: + +
    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    spec
    PodSpec
    Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    status
    PodStatus
    Most recently observed status of the pod. This data may not be up to date. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    +

    PodSpec v1 core

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    activeDeadlineSeconds
    integer
    Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer.
    affinity
    Affinity
    If specified, the pod's scheduling constraints
    automountServiceAccountToken
    boolean
    AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.
    containers
    Container array
    patch strategy: merge
    patch merge key: name
    List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated.
    dnsConfig
    PodDNSConfig
    Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.
    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'.
    enableServiceLinks
    boolean
    EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. Optional: Defaults to true.
    ephemeralContainers
    EphemeralContainer array
    patch strategy: merge
    patch merge key: name
    List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod's ephemeralcontainers subresource. This field is alpha-level and is only honored by servers that enable the EphemeralContainers feature.
    hostAliases
    HostAlias array
    patch strategy: merge
    patch merge key: ip
    HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods.
    hostIPC
    boolean
    Use the host's ipc namespace. Optional: Default to false.
    hostNetwork
    boolean
    Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false.
    hostPID
    boolean
    Use the host's pid namespace. Optional: Default to false.
    hostname
    string
    Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value.
    imagePullSecrets
    LocalObjectReference array
    patch strategy: merge
    patch merge key: name
    ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod
    initContainers
    Container array
    patch strategy: merge
    patch merge key: name
    List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
    nodeName
    string
    NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.
    nodeSelector
    object
    NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
    overhead
    object
    Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md This field is alpha-level as of Kubernetes v1.16, and is only honored by servers that enable the PodOverhead feature.
    preemptionPolicy
    string
    PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate.
    priority
    integer
    The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority.
    priorityClassName
    string
    If specified, indicates the pod's priority. "system-node-critical" and "system-cluster-critical" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default.
    readinessGates
    PodReadinessGate array
    If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/0007-pod-ready%2B%2B.md
    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
    runtimeClassName
    string
    RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md This is a beta feature as of Kubernetes v1.14.
    schedulerName
    string
    If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.
    securityContext
    PodSecurityContext
    SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.
    serviceAccount
    string
    DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.
    serviceAccountName
    string
    ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
    setHostnameAsFQDN
    boolean
    If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default). In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname). In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters to FQDN. If a pod does not have FQDN, this has no effect. Default to false.
    shareProcessNamespace
    boolean
    Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false.
    subdomain
    string
    If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>". If not specified, the pod will not have a domainname at all.
    terminationGracePeriodSeconds
    integer
    Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.
    tolerations
    Toleration array
    If specified, the pod's tolerations.
    topologySpreadConstraints
    TopologySpreadConstraint array
    patch strategy: merge
    patch merge key: topologyKey
    TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed.
    volumes
    Volume array
    patch strategy: merge,retainKeys
    patch merge key: name
    List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes
    +

    PodStatus v1 core

    +
    Appears In: + +
    + + + + + + + + + + + + + + + + + +
    FieldDescription
    conditions
    PodCondition array
    patch strategy: merge
    patch merge key: type
    Current service state of pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions
    containerStatuses
    ContainerStatus array
    The list has one entry per container in the manifest. Each entry is currently the output of `docker inspect`. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status
    ephemeralContainerStatuses
    ContainerStatus array
    Status for any ephemeral containers that have run in this pod. This field is alpha-level and is only populated by servers that enable the EphemeralContainers feature.
    hostIP
    string
    IP address of the host to which the pod is assigned. Empty if not yet scheduled.
    initContainerStatuses
    ContainerStatus array
    The list has one entry per init container in the manifest. The most recent successful init container will have ready = true, the most recently started container will have startTime set. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status
    message
    string
    A human readable message indicating details about why the pod is in this condition.
    nominatedNodeName
    string
    nominatedNodeName is set only when this pod preempts other pods on the node, but it cannot be scheduled right away as preemption victims receive their graceful termination periods. This field does not guarantee that the pod will be scheduled on this node. Scheduler may decide to place the pod elsewhere if other nodes become available sooner. Scheduler may also decide to give the resources on this node to a higher priority pod that is created after preemption. As a result, this field may be different than PodSpec.nodeName when the pod is scheduled.
    phase
    string
    The phase of a Pod is a simple, high-level summary of where the Pod is in its lifecycle. The conditions array, the reason and message fields, and the individual container status arrays contain more detail about the pod's status. There are five possible phase values: Pending: The pod has been accepted by the Kubernetes system, but one or more of the container images has not been created. This includes time before being scheduled as well as time spent downloading images over the network, which could take a while. Running: The pod has been bound to a node, and all of the containers have been created. At least one container is still running, or is in the process of starting or restarting. Succeeded: All containers in the pod have terminated in success, and will not be restarted. Failed: All containers in the pod have terminated, and at least one container has terminated in failure. The container either exited with non-zero status or was terminated by the system. Unknown: For some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-phase
    podIP
    string
    IP address allocated to the pod. Routable at least within the cluster. Empty if not yet allocated.
    podIPs
    PodIP array
    patch strategy: merge
    patch merge key: ip
    podIPs holds the IP addresses allocated to the pod. If this field is specified, the 0th entry must match the podIP field. Pods may be allocated at most 1 value for each of IPv4 and IPv6. This list is empty if no IPs have been allocated yet.
    qosClass
    string
    The Quality of Service (QOS) classification assigned to the pod based on resource requirements See PodQOSClass type for available QOS classes More info: https://git.k8s.io/community/contributors/design-proposals/node/resource-qos.md
    reason
    string
    A brief CamelCase message indicating details about why the pod is in this state. e.g. 'Evicted'
    startTime
    Time
    RFC 3339 date and time at which the object was acknowledged by the Kubelet. This is before the Kubelet pulled the container image(s) for the pod.
    +

    PodList v1 core

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    Pod array
    List of pods. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    +

    Write Operations

    +

    Create

    +

    create a Pod

    +

    HTTP Request

    +POST /api/v1/namespaces/{namespace}/pods +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Pod
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    Pod
    OK
    201
    Pod
    Created
    202
    Pod
    Accepted
    +

    Create Eviction

    +

    create eviction of a Pod

    +

    HTTP Request

    +POST /api/v1/namespaces/{namespace}/pods/{name}/eviction +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Eviction
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    dryRunWhen 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
    fieldManagerfieldManager 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.
    prettyIf 'true', then the output is pretty printed.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Eviction
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    Eviction
    OK
    201
    Eviction
    Created
    202
    Eviction
    Accepted
    +

    Patch

    +

    partially update the specified Pod

    +

    HTTP Request

    +PATCH /api/v1/namespaces/{namespace}/pods/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Pod
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    Pod
    OK
    +

    Replace

    +

    replace the specified Pod

    +

    HTTP Request

    +PUT /api/v1/namespaces/{namespace}/pods/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Pod
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Pod
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Pod
    OK
    201
    Pod
    Created
    +

    Delete

    +

    delete a Pod

    +

    HTTP Request

    +DELETE /api/v1/namespaces/{namespace}/pods/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Pod
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Pod
    OK
    202
    Pod
    Accepted
    +

    Delete Collection

    +

    delete collection of Pod

    +

    HTTP Request

    +DELETE /api/v1/namespaces/{namespace}/pods +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified Pod

    +

    HTTP Request

    +GET /api/v1/namespaces/{namespace}/pods/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Pod
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    Pod
    OK
    +

    List

    +

    list or watch objects of kind Pod

    +

    HTTP Request

    +GET /api/v1/namespaces/{namespace}/pods +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    PodList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind Pod

    +

    HTTP Request

    +GET /api/v1/pods +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    PodList
    OK
    +

    Watch

    +

    watch changes to an object of kind Pod. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /api/v1/watch/namespaces/{namespace}/pods/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Pod
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of Pod. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /api/v1/watch/namespaces/{namespace}/pods +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of Pod. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /api/v1/watch/pods +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Status Operations

    +

    Patch Status

    +

    partially update status of the specified Pod

    +

    HTTP Request

    +PATCH /api/v1/namespaces/{namespace}/pods/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Pod
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    Pod
    OK
    +

    Read Status

    +

    read status of the specified Pod

    +

    HTTP Request

    +GET /api/v1/namespaces/{namespace}/pods/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Pod
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    Pod
    OK
    +

    Replace Status

    +

    replace status of the specified Pod

    +

    HTTP Request

    +PUT /api/v1/namespaces/{namespace}/pods/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Pod
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Pod
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Pod
    OK
    201
    Pod
    Created
    +

    Proxy Operations

    +

    Create Connect Portforward

    +

    connect POST requests to portforward of Pod

    +

    HTTP Request

    +POST /api/v1/namespaces/{namespace}/pods/{name}/portforward +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the PodPortForwardOptions
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    portsList of ports to forward Required when using WebSockets
    +

    Response

    + + + + + +
    CodeDescription
    200
    string
    OK
    +

    Create Connect Proxy

    +

    connect POST requests to proxy of Pod

    +

    HTTP Request

    +POST /api/v1/namespaces/{namespace}/pods/{name}/proxy +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the PodProxyOptions
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    pathPath is the URL path to use for the current proxy request to pod.
    +

    Response

    + + + + + +
    CodeDescription
    200
    string
    OK
    +

    Create Connect Proxy Path

    +

    connect POST requests to proxy of Pod

    +

    HTTP Request

    +POST /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} +

    Path Parameters

    + + + + + + + +
    ParameterDescription
    namename of the PodProxyOptions
    namespaceobject name and auth scope, such as for teams and projects
    pathpath to the resource
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    pathPath is the URL path to use for the current proxy request to pod.
    +

    Response

    + + + + + +
    CodeDescription
    200
    string
    OK
    +

    Delete Connect Proxy

    +

    connect DELETE requests to proxy of Pod

    +

    HTTP Request

    +DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the PodProxyOptions
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    pathPath is the URL path to use for the current proxy request to pod.
    +

    Response

    + + + + + +
    CodeDescription
    200
    string
    OK
    +

    Delete Connect Proxy Path

    +

    connect DELETE requests to proxy of Pod

    +

    HTTP Request

    +DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} +

    Path Parameters

    + + + + + + + +
    ParameterDescription
    namename of the PodProxyOptions
    namespaceobject name and auth scope, such as for teams and projects
    pathpath to the resource
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    pathPath is the URL path to use for the current proxy request to pod.
    +

    Response

    + + + + + +
    CodeDescription
    200
    string
    OK
    +

    Get Connect Portforward

    +

    connect GET requests to portforward of Pod

    +

    HTTP Request

    +GET /api/v1/namespaces/{namespace}/pods/{name}/portforward +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the PodPortForwardOptions
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    portsList of ports to forward Required when using WebSockets
    +

    Response

    + + + + + +
    CodeDescription
    200
    string
    OK
    +

    Get Connect Proxy

    +

    connect GET requests to proxy of Pod

    +

    HTTP Request

    +GET /api/v1/namespaces/{namespace}/pods/{name}/proxy +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the PodProxyOptions
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    pathPath is the URL path to use for the current proxy request to pod.
    +

    Response

    + + + + + +
    CodeDescription
    200
    string
    OK
    +

    Get Connect Proxy Path

    +

    connect GET requests to proxy of Pod

    +

    HTTP Request

    +GET /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} +

    Path Parameters

    + + + + + + + +
    ParameterDescription
    namename of the PodProxyOptions
    namespaceobject name and auth scope, such as for teams and projects
    pathpath to the resource
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    pathPath is the URL path to use for the current proxy request to pod.
    +

    Response

    + + + + + +
    CodeDescription
    200
    string
    OK
    +

    Head Connect Proxy

    +

    connect HEAD requests to proxy of Pod

    +

    HTTP Request

    +HEAD /api/v1/namespaces/{namespace}/pods/{name}/proxy +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the PodProxyOptions
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    pathPath is the URL path to use for the current proxy request to pod.
    +

    Response

    + + + + + +
    CodeDescription
    200
    string
    OK
    +

    Head Connect Proxy Path

    +

    connect HEAD requests to proxy of Pod

    +

    HTTP Request

    +HEAD /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} +

    Path Parameters

    + + + + + + + +
    ParameterDescription
    namename of the PodProxyOptions
    namespaceobject name and auth scope, such as for teams and projects
    pathpath to the resource
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    pathPath is the URL path to use for the current proxy request to pod.
    +

    Response

    + + + + + +
    CodeDescription
    200
    string
    OK
    +

    Replace Connect Proxy

    +

    connect PUT requests to proxy of Pod

    +

    HTTP Request

    +PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the PodProxyOptions
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    pathPath is the URL path to use for the current proxy request to pod.
    +

    Response

    + + + + + +
    CodeDescription
    200
    string
    OK
    +

    Replace Connect Proxy Path

    +

    connect PUT requests to proxy of Pod

    +

    HTTP Request

    +PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} +

    Path Parameters

    + + + + + + + +
    ParameterDescription
    namename of the PodProxyOptions
    namespaceobject name and auth scope, such as for teams and projects
    pathpath to the resource
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    pathPath is the URL path to use for the current proxy request to pod.
    +

    Response

    + + + + + +
    CodeDescription
    200
    string
    OK
    +

    Misc Operations

    +

    Read Log

    +

    read log of the specified Pod

    +

    HTTP Request

    +GET /api/v1/namespaces/{namespace}/pods/{name}/log +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Pod
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + +
    ParameterDescription
    containerThe container for which to stream logs. Defaults to only container if there is one container in the pod.
    followFollow the log stream of the pod. Defaults to false.
    insecureSkipTLSVerifyBackendinsecureSkipTLSVerifyBackend indicates that the apiserver should not confirm the validity of the serving certificate of the backend it is connecting to. This will make the HTTPS connection between the apiserver and the backend insecure. This means the apiserver cannot verify the log data it is receiving came from the real kubelet. If the kubelet is configured to verify the apiserver's TLS credentials, it does not mean the connection to the real kubelet is vulnerable to a man in the middle attack (e.g. an attacker could not intercept the actual log data coming from the real kubelet).
    limitBytesIf set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit.
    prettyIf 'true', then the output is pretty printed.
    previousReturn previous terminated container logs. Defaults to false.
    sinceSecondsA relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified.
    tailLinesIf set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime
    timestampsIf true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false.
    +

    Response

    + + + + + +
    CodeDescription
    200
    string
    OK
    +

    ReplicaSet v1 apps

    + +
    +
    +
    ReplicaSet Config to run 3 nginx instances.
    +
    +
    
    +apiVersion: apps/v1
    +kind: ReplicaSet
    +metadata:
    +  # Unique key of the ReplicaSet instance
    +  name: replicaset-example
    +spec:
    +  # 3 Pods should exist at all times.
    +  replicas: 3
    +  selector:
    +    matchLabels:
    +      app: nginx
    +  template:
    +    metadata:
    +      labels:
    +        app: nginx
    +    spec:
    +      containers:
    +      # Run the nginx image
    +      - name: nginx
    +        image: nginx:1.14
    +
    +
    + + + + + +
    GroupVersionKind
    appsv1ReplicaSet
    +

    Warning:

    In many cases it is recommended to create a Deployment instead of ReplicaSet.

    +
    Appears In: + +
    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    If the Labels of a ReplicaSet are empty, they are defaulted to be the same as the Pod(s) that the ReplicaSet manages. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    spec
    ReplicaSetSpec
    Spec defines the specification of the desired behavior of the ReplicaSet. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    status
    ReplicaSetStatus
    Status is the most recently observed status of the ReplicaSet. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    +

    ReplicaSetSpec v1 apps

    +
    Appears In: + +
    + + + + + + + + +
    FieldDescription
    minReadySeconds
    integer
    Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
    replicas
    integer
    Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller
    selector
    LabelSelector
    Selector is a label query over pods that should match the replica count. Label keys and values that must match in order to be controlled by this replica set. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
    template
    PodTemplateSpec
    Template is the object that describes the pod that will be created if insufficient replicas are detected. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template
    +

    ReplicaSetStatus v1 apps

    +
    Appears In: + +
    + + + + + + + + + + +
    FieldDescription
    availableReplicas
    integer
    The number of available replicas (ready for at least minReadySeconds) for this replica set.
    conditions
    ReplicaSetCondition array
    patch strategy: merge
    patch merge key: type
    Represents the latest available observations of a replica set's current state.
    fullyLabeledReplicas
    integer
    The number of pods that have labels matching the labels of the pod template of the replicaset.
    observedGeneration
    integer
    ObservedGeneration reflects the generation of the most recently observed ReplicaSet.
    readyReplicas
    integer
    The number of ready replicas for this replica set.
    replicas
    integer
    Replicas is the most recently oberved number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller
    +

    ReplicaSetList v1 apps

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    ReplicaSet array
    List of ReplicaSets. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    +

    Write Operations

    +

    Create

    +

    create a ReplicaSet

    +

    HTTP Request

    +POST /apis/apps/v1/namespaces/{namespace}/replicasets +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    ReplicaSet
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    ReplicaSet
    OK
    201
    ReplicaSet
    Created
    202
    ReplicaSet
    Accepted
    +

    Patch

    +

    partially update the specified ReplicaSet

    +

    HTTP Request

    +PATCH /apis/apps/v1/namespaces/{namespace}/replicasets/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ReplicaSet
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    ReplicaSet
    OK
    +

    Replace

    +

    replace the specified ReplicaSet

    +

    HTTP Request

    +PUT /apis/apps/v1/namespaces/{namespace}/replicasets/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ReplicaSet
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    ReplicaSet
    +

    Response

    + + + + + + +
    CodeDescription
    200
    ReplicaSet
    OK
    201
    ReplicaSet
    Created
    +

    Delete

    +

    delete a ReplicaSet

    +

    HTTP Request

    +DELETE /apis/apps/v1/namespaces/{namespace}/replicasets/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ReplicaSet
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of ReplicaSet

    +

    HTTP Request

    +DELETE /apis/apps/v1/namespaces/{namespace}/replicasets +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified ReplicaSet

    +

    HTTP Request

    +GET /apis/apps/v1/namespaces/{namespace}/replicasets/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ReplicaSet
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    ReplicaSet
    OK
    +

    List

    +

    list or watch objects of kind ReplicaSet

    +

    HTTP Request

    +GET /apis/apps/v1/namespaces/{namespace}/replicasets +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    ReplicaSetList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind ReplicaSet

    +

    HTTP Request

    +GET /apis/apps/v1/replicasets +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    ReplicaSetList
    OK
    +

    Watch

    +

    watch changes to an object of kind ReplicaSet. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/apps/v1/watch/namespaces/{namespace}/replicasets/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ReplicaSet
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of ReplicaSet. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/apps/v1/watch/namespaces/{namespace}/replicasets +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of ReplicaSet. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/apps/v1/watch/replicasets +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Status Operations

    +

    Patch Status

    +

    partially update status of the specified ReplicaSet

    +

    HTTP Request

    +PATCH /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ReplicaSet
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    ReplicaSet
    OK
    +

    Read Status

    +

    read status of the specified ReplicaSet

    +

    HTTP Request

    +GET /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ReplicaSet
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    ReplicaSet
    OK
    +

    Replace Status

    +

    replace status of the specified ReplicaSet

    +

    HTTP Request

    +PUT /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ReplicaSet
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    ReplicaSet
    +

    Response

    + + + + + + +
    CodeDescription
    200
    ReplicaSet
    OK
    201
    ReplicaSet
    Created
    +

    Misc Operations

    +

    Read Scale

    +

    read scale of the specified ReplicaSet

    +

    HTTP Request

    +GET /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Scale
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    Scale
    OK
    +

    Replace Scale

    +

    replace scale of the specified ReplicaSet

    +

    HTTP Request

    +PUT /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Scale
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Scale
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Scale
    OK
    201
    Scale
    Created
    +

    Patch Scale

    +

    partially update scale of the specified ReplicaSet

    +

    HTTP Request

    +PATCH /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Scale
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    Scale
    OK
    +

    ReplicationController v1 core

    + +
    +
    +
    ReplicationController Config to run 3 nginx instances.
    +
    +
    
    +apiVersion: v1
    +kind: ReplicationController
    +metadata:
    +  # Unique key of the ReplicationController instance
    +  name: replicationcontroller-example
    +spec:
    +  # 3 Pods should exist at all times.
    +  replicas: 3
    +  template:
    +    metadata:
    +      labels:
    +        app: nginx
    +    spec:
    +      containers:
    +      # Run the nginx image
    +      - name: nginx
    +        image: nginx:1.14
    +
    +
    + + + + + +
    GroupVersionKind
    corev1ReplicationController
    +

    Warning:

    In many cases it is recommended to create a Deployment instead of a ReplicationController.

    + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    If the Labels of a ReplicationController are empty, they are defaulted to be the same as the Pod(s) that the replication controller manages. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    spec
    ReplicationControllerSpec
    Spec defines the specification of the desired behavior of the replication controller. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    status
    ReplicationControllerStatus
    Status is the most recently observed status of the replication controller. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    +

    ReplicationControllerSpec v1 core

    +
    Appears In: + +
    + + + + + + + + +
    FieldDescription
    minReadySeconds
    integer
    Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
    replicas
    integer
    Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller
    selector
    object
    Selector is a label query over pods that should match the Replicas count. If Selector is empty, it is defaulted to the labels present on the Pod template. Label keys and values that must match in order to be controlled by this replication controller, if empty defaulted to labels on Pod template. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
    template
    PodTemplateSpec
    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
    +

    ReplicationControllerStatus v1 core

    +
    Appears In: + +
    + + + + + + + + + + +
    FieldDescription
    availableReplicas
    integer
    The number of available replicas (ready for at least minReadySeconds) for this replication controller.
    conditions
    ReplicationControllerCondition array
    patch strategy: merge
    patch merge key: type
    Represents the latest available observations of a replication controller's current state.
    fullyLabeledReplicas
    integer
    The number of pods that have labels matching the labels of the pod template of the replication controller.
    observedGeneration
    integer
    ObservedGeneration reflects the generation of the most recently observed replication controller.
    readyReplicas
    integer
    The number of ready replicas for this replication controller.
    replicas
    integer
    Replicas is the most recently oberved number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller
    +

    ReplicationControllerList v1 core

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    ReplicationController array
    List of replication controllers. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    +

    Write Operations

    +

    Create

    +

    create a ReplicationController

    +

    HTTP Request

    +POST /api/v1/namespaces/{namespace}/replicationcontrollers +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    ReplicationController
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    ReplicationController
    OK
    201
    ReplicationController
    Created
    202
    ReplicationController
    Accepted
    +

    Patch

    +

    partially update the specified ReplicationController

    +

    HTTP Request

    +PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ReplicationController
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    ReplicationController
    OK
    +

    Replace

    +

    replace the specified ReplicationController

    +

    HTTP Request

    +PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ReplicationController
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    ReplicationController
    +

    Response

    + + + + + + +
    CodeDescription
    200
    ReplicationController
    OK
    201
    ReplicationController
    Created
    +

    Delete

    +

    delete a ReplicationController

    +

    HTTP Request

    +DELETE /api/v1/namespaces/{namespace}/replicationcontrollers/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ReplicationController
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of ReplicationController

    +

    HTTP Request

    +DELETE /api/v1/namespaces/{namespace}/replicationcontrollers +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified ReplicationController

    +

    HTTP Request

    +GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ReplicationController
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    ReplicationController
    OK
    +

    List

    +

    list or watch objects of kind ReplicationController

    +

    HTTP Request

    +GET /api/v1/namespaces/{namespace}/replicationcontrollers +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    ReplicationControllerList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind ReplicationController

    +

    HTTP Request

    +GET /api/v1/replicationcontrollers +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    ReplicationControllerList
    OK
    +

    Watch

    +

    watch changes to an object of kind ReplicationController. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ReplicationController
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of ReplicationController. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of ReplicationController. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /api/v1/watch/replicationcontrollers +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Status Operations

    +

    Patch Status

    +

    partially update status of the specified ReplicationController

    +

    HTTP Request

    +PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ReplicationController
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    ReplicationController
    OK
    +

    Read Status

    +

    read status of the specified ReplicationController

    +

    HTTP Request

    +GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ReplicationController
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    ReplicationController
    OK
    +

    Replace Status

    +

    replace status of the specified ReplicationController

    +

    HTTP Request

    +PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ReplicationController
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    ReplicationController
    +

    Response

    + + + + + + +
    CodeDescription
    200
    ReplicationController
    OK
    201
    ReplicationController
    Created
    +

    Misc Operations

    +

    Read Scale

    +

    read scale of the specified ReplicationController

    +

    HTTP Request

    +GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Scale
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    Scale
    OK
    +

    Replace Scale

    +

    replace scale of the specified ReplicationController

    +

    HTTP Request

    +PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Scale
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Scale
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Scale
    OK
    201
    Scale
    Created
    +

    Patch Scale

    +

    partially update scale of the specified ReplicationController

    +

    HTTP Request

    +PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Scale
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    Scale
    OK
    +

    StatefulSet v1 apps

    + + + + + +
    GroupVersionKind
    appsv1StatefulSet
    +
    Appears In: + +
    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    spec
    StatefulSetSpec
    Spec defines the desired identities of pods in this set.
    status
    StatefulSetStatus
    Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time.
    +

    StatefulSetSpec v1 apps

    +
    Appears In: + +
    + + + + + + + + + + + + +
    FieldDescription
    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.
    replicas
    integer
    replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.
    revisionHistoryLimit
    integer
    revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.
    selector
    LabelSelector
    selector is a label query over pods that should match the replica count. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
    serviceName
    string
    serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller.
    template
    PodTemplateSpec
    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.
    updateStrategy
    StatefulSetUpdateStrategy
    updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template.
    volumeClaimTemplates
    PersistentVolumeClaim array
    volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.
    +

    StatefulSetStatus v1 apps

    +
    Appears In: + +
    + + + + + + + + + + + + + +
    FieldDescription
    collisionCount
    integer
    collisionCount is the count of hash collisions for the StatefulSet. The StatefulSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision.
    conditions
    StatefulSetCondition array
    patch strategy: merge
    patch merge key: type
    Represents the latest available observations of a statefulset's current state.
    currentReplicas
    integer
    currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by currentRevision.
    currentRevision
    string
    currentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas).
    observedGeneration
    integer
    observedGeneration is the most recent generation observed for this StatefulSet. It corresponds to the StatefulSet's generation, which is updated on mutation by the API Server.
    readyReplicas
    integer
    readyReplicas is the number of Pods created by the StatefulSet controller that have a Ready Condition.
    replicas
    integer
    replicas is the number of Pods created by the StatefulSet controller.
    updateRevision
    string
    updateRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [replicas-updatedReplicas,replicas)
    updatedReplicas
    integer
    updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision.
    +

    StatefulSetList v1 apps

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    StatefulSet array
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    +

    Write Operations

    +

    Create

    +

    create a StatefulSet

    +

    HTTP Request

    +POST /apis/apps/v1/namespaces/{namespace}/statefulsets +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    StatefulSet
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    StatefulSet
    OK
    201
    StatefulSet
    Created
    202
    StatefulSet
    Accepted
    +

    Patch

    +

    partially update the specified StatefulSet

    +

    HTTP Request

    +PATCH /apis/apps/v1/namespaces/{namespace}/statefulsets/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the StatefulSet
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    StatefulSet
    OK
    +

    Replace

    +

    replace the specified StatefulSet

    +

    HTTP Request

    +PUT /apis/apps/v1/namespaces/{namespace}/statefulsets/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the StatefulSet
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    StatefulSet
    +

    Response

    + + + + + + +
    CodeDescription
    200
    StatefulSet
    OK
    201
    StatefulSet
    Created
    +

    Delete

    +

    delete a StatefulSet

    +

    HTTP Request

    +DELETE /apis/apps/v1/namespaces/{namespace}/statefulsets/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the StatefulSet
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of StatefulSet

    +

    HTTP Request

    +DELETE /apis/apps/v1/namespaces/{namespace}/statefulsets +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified StatefulSet

    +

    HTTP Request

    +GET /apis/apps/v1/namespaces/{namespace}/statefulsets/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the StatefulSet
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    StatefulSet
    OK
    +

    List

    +

    list or watch objects of kind StatefulSet

    +

    HTTP Request

    +GET /apis/apps/v1/namespaces/{namespace}/statefulsets +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    StatefulSetList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind StatefulSet

    +

    HTTP Request

    +GET /apis/apps/v1/statefulsets +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    StatefulSetList
    OK
    +

    Watch

    +

    watch changes to an object of kind StatefulSet. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/apps/v1/watch/namespaces/{namespace}/statefulsets/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the StatefulSet
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of StatefulSet. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/apps/v1/watch/namespaces/{namespace}/statefulsets +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of StatefulSet. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/apps/v1/watch/statefulsets +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Status Operations

    +

    Patch Status

    +

    partially update status of the specified StatefulSet

    +

    HTTP Request

    +PATCH /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the StatefulSet
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    StatefulSet
    OK
    +

    Read Status

    +

    read status of the specified StatefulSet

    +

    HTTP Request

    +GET /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the StatefulSet
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    StatefulSet
    OK
    +

    Replace Status

    +

    replace status of the specified StatefulSet

    +

    HTTP Request

    +PUT /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the StatefulSet
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    StatefulSet
    +

    Response

    + + + + + + +
    CodeDescription
    200
    StatefulSet
    OK
    201
    StatefulSet
    Created
    +

    Misc Operations

    +

    Read Scale

    +

    read scale of the specified StatefulSet

    +

    HTTP Request

    +GET /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Scale
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    Scale
    OK
    +

    Replace Scale

    +

    replace scale of the specified StatefulSet

    +

    HTTP Request

    +PUT /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Scale
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Scale
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Scale
    OK
    201
    Scale
    Created
    +

    Patch Scale

    +

    partially update scale of the specified StatefulSet

    +

    HTTP Request

    +PATCH /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Scale
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    Scale
    OK
    +

    SERVICE APIs

    + +

    Service API resources are responsible for stitching your workloads together into an accessible Loadbalanced Service. By default, +Workloads are only accessible within the cluster, and they must be exposed externally using a either +a *LoadBalancer* or *NodePort* Service. For development, internally accessible +Workloads can be accessed via proxy through the api master using the kubectl proxy command.

    + +

    Common resource types:

    + +
      +
    • Services for providing a single ip endpoint loadbalanced across multiple Workload replicas.
    • +
    • Ingress for providing a https(s) endpoint http(s) routed to one or more *Services*.
    • +
    +
    +

    Endpoints v1 core

    + + + + + +
    GroupVersionKind
    corev1Endpoints
    +
    Appears In: + +
    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    subsets
    EndpointSubset array
    The set of all endpoints is the union of all subsets. Addresses are placed into subsets according to the IPs they share. A single address with multiple ports, some of which are ready and some of which are not (because they come from different containers) will result in the address being displayed in different subsets for the different ports. No address will appear in both Addresses and NotReadyAddresses in the same subset. Sets of addresses and ports that comprise a service.
    +

    EndpointsList v1 core

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    Endpoints array
    List of endpoints.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    +

    Write Operations

    +

    Create

    +

    create Endpoints

    +

    HTTP Request

    +POST /api/v1/namespaces/{namespace}/endpoints +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Endpoints
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    Endpoints
    OK
    201
    Endpoints
    Created
    202
    Endpoints
    Accepted
    +

    Patch

    +

    partially update the specified Endpoints

    +

    HTTP Request

    +PATCH /api/v1/namespaces/{namespace}/endpoints/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Endpoints
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    Endpoints
    OK
    +

    Replace

    +

    replace the specified Endpoints

    +

    HTTP Request

    +PUT /api/v1/namespaces/{namespace}/endpoints/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Endpoints
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Endpoints
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Endpoints
    OK
    201
    Endpoints
    Created
    +

    Delete

    +

    delete Endpoints

    +

    HTTP Request

    +DELETE /api/v1/namespaces/{namespace}/endpoints/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Endpoints
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of Endpoints

    +

    HTTP Request

    +DELETE /api/v1/namespaces/{namespace}/endpoints +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified Endpoints

    +

    HTTP Request

    +GET /api/v1/namespaces/{namespace}/endpoints/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Endpoints
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    Endpoints
    OK
    +

    List

    +

    list or watch objects of kind Endpoints

    +

    HTTP Request

    +GET /api/v1/namespaces/{namespace}/endpoints +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    EndpointsList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind Endpoints

    +

    HTTP Request

    +GET /api/v1/endpoints +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    EndpointsList
    OK
    +

    Watch

    +

    watch changes to an object of kind Endpoints. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /api/v1/watch/namespaces/{namespace}/endpoints/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Endpoints
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of Endpoints. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /api/v1/watch/namespaces/{namespace}/endpoints +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of Endpoints. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /api/v1/watch/endpoints +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    EndpointSlice v1beta1 discovery.k8s.io

    + + + + + +
    GroupVersionKind
    discovery.k8s.iov1beta1EndpointSlice
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + + + + + +
    FieldDescription
    addressType
    string
    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.
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    endpoints
    Endpoint array
    endpoints is a list of unique endpoints in this slice. Each slice may include a maximum of 1000 endpoints.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata.
    ports
    EndpointPort array
    ports specifies the list of network ports exposed by each endpoint in this slice. Each port must have a unique name. When ports is empty, it indicates that there are no defined ports. When a port is defined with a nil port value, it indicates "all ports". Each slice may include a maximum of 100 ports.
    +

    EndpointSliceList v1beta1 discovery

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    EndpointSlice array
    List of endpoint slices
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata.
    +

    Write Operations

    +

    Create

    +

    create an EndpointSlice

    +

    HTTP Request

    +POST /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    EndpointSlice
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    EndpointSlice
    OK
    201
    EndpointSlice
    Created
    202
    EndpointSlice
    Accepted
    +

    Patch

    +

    partially update the specified EndpointSlice

    +

    HTTP Request

    +PATCH /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the EndpointSlice
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    EndpointSlice
    OK
    +

    Replace

    +

    replace the specified EndpointSlice

    +

    HTTP Request

    +PUT /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the EndpointSlice
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    EndpointSlice
    +

    Response

    + + + + + + +
    CodeDescription
    200
    EndpointSlice
    OK
    201
    EndpointSlice
    Created
    +

    Delete

    +

    delete an EndpointSlice

    +

    HTTP Request

    +DELETE /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the EndpointSlice
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of EndpointSlice

    +

    HTTP Request

    +DELETE /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified EndpointSlice

    +

    HTTP Request

    +GET /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the EndpointSlice
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    EndpointSlice
    OK
    +

    List

    +

    list or watch objects of kind EndpointSlice

    +

    HTTP Request

    +GET /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    EndpointSliceList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind EndpointSlice

    +

    HTTP Request

    +GET /apis/discovery.k8s.io/v1beta1/endpointslices +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    EndpointSliceList
    OK
    +

    Watch

    +

    watch changes to an object of kind EndpointSlice. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/discovery.k8s.io/v1beta1/watch/namespaces/{namespace}/endpointslices/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the EndpointSlice
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of EndpointSlice. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/discovery.k8s.io/v1beta1/watch/namespaces/{namespace}/endpointslices +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of EndpointSlice. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/discovery.k8s.io/v1beta1/watch/endpointslices +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Ingress v1 networking.k8s.io

    + + + + + +
    GroupVersionKind
    networking.k8s.iov1Ingress
    +
    Other API versions of this object exist: +v1beta1 +v1beta1 +
    +
    Appears In: + +
    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    spec
    IngressSpec
    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
    IngressStatus
    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
    +

    IngressSpec v1 networking

    +
    Appears In: + +
    + + + + + + + + +
    FieldDescription
    defaultBackend
    IngressBackend
    DefaultBackend is the backend that should handle requests that don't match any rule. If Rules are not specified, DefaultBackend must be specified. If DefaultBackend is not set, the handling of requests that do not match any of the rules will be up to the Ingress controller.
    ingressClassName
    string
    IngressClassName is the name of the IngressClass cluster resource. The associated IngressClass defines which controller will implement the resource. This replaces the deprecated `kubernetes.io/ingress.class` annotation. For backwards compatibility, when that annotation is set, it must be given precedence over this field. The controller may emit a warning if the field and annotation have different values. Implementations of this API should ignore Ingresses without a class specified. An IngressClass resource may be marked as default, which can be used to set a default value for this field. For more information, refer to the IngressClass documentation.
    rules
    IngressRule array
    A list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend.
    tls
    IngressTLS array
    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.
    +

    IngressStatus v1 networking

    +
    Appears In: + +
    + + + + + +
    FieldDescription
    loadBalancer
    LoadBalancerStatus
    LoadBalancer contains the current status of the load-balancer.
    +

    IngressList v1 networking

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    Ingress array
    Items is the list of Ingress.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    +

    Write Operations

    +

    Create

    +

    create an Ingress

    +

    HTTP Request

    +POST /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Ingress
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    Ingress
    OK
    201
    Ingress
    Created
    202
    Ingress
    Accepted
    +

    Patch

    +

    partially update the specified Ingress

    +

    HTTP Request

    +PATCH /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Ingress
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    Ingress
    OK
    +

    Replace

    +

    replace the specified Ingress

    +

    HTTP Request

    +PUT /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Ingress
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Ingress
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Ingress
    OK
    201
    Ingress
    Created
    +

    Delete

    +

    delete an Ingress

    +

    HTTP Request

    +DELETE /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Ingress
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of Ingress

    +

    HTTP Request

    +DELETE /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified Ingress

    +

    HTTP Request

    +GET /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Ingress
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    Ingress
    OK
    +

    List

    +

    list or watch objects of kind Ingress

    +

    HTTP Request

    +GET /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    IngressList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind Ingress

    +

    HTTP Request

    +GET /apis/networking.k8s.io/v1/ingresses +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    IngressList
    OK
    +

    Watch

    +

    watch changes to an object of kind Ingress. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/networking.k8s.io/v1/watch/namespaces/{namespace}/ingresses/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Ingress
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of Ingress. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/networking.k8s.io/v1/watch/namespaces/{namespace}/ingresses +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of Ingress. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/networking.k8s.io/v1/watch/ingresses +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Status Operations

    +

    Patch Status

    +

    partially update status of the specified Ingress

    +

    HTTP Request

    +PATCH /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Ingress
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    Ingress
    OK
    +

    Read Status

    +

    read status of the specified Ingress

    +

    HTTP Request

    +GET /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Ingress
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    Ingress
    OK
    +

    Replace Status

    +

    replace status of the specified Ingress

    +

    HTTP Request

    +PUT /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Ingress
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Ingress
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Ingress
    OK
    201
    Ingress
    Created
    +

    IngressClass v1 networking.k8s.io

    + + + + + +
    GroupVersionKind
    networking.k8s.iov1IngressClass
    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    spec
    IngressClassSpec
    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
    +

    IngressClassSpec v1 networking

    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    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.
    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.
    +

    IngressClassList v1 networking

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    IngressClass array
    Items is the list of IngressClasses.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata.
    +

    Write Operations

    +

    Create

    +

    create an IngressClass

    +

    HTTP Request

    +POST /apis/networking.k8s.io/v1/ingressclasses +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    IngressClass
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    IngressClass
    OK
    201
    IngressClass
    Created
    202
    IngressClass
    Accepted
    +

    Patch

    +

    partially update the specified IngressClass

    +

    HTTP Request

    +PATCH /apis/networking.k8s.io/v1/ingressclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the IngressClass
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    IngressClass
    OK
    +

    Replace

    +

    replace the specified IngressClass

    +

    HTTP Request

    +PUT /apis/networking.k8s.io/v1/ingressclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the IngressClass
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    IngressClass
    +

    Response

    + + + + + + +
    CodeDescription
    200
    IngressClass
    OK
    201
    IngressClass
    Created
    +

    Delete

    +

    delete an IngressClass

    +

    HTTP Request

    +DELETE /apis/networking.k8s.io/v1/ingressclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the IngressClass
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of IngressClass

    +

    HTTP Request

    +DELETE /apis/networking.k8s.io/v1/ingressclasses +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified IngressClass

    +

    HTTP Request

    +GET /apis/networking.k8s.io/v1/ingressclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the IngressClass
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    IngressClass
    OK
    +

    List

    +

    list or watch objects of kind IngressClass

    +

    HTTP Request

    +GET /apis/networking.k8s.io/v1/ingressclasses +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    IngressClassList
    OK
    +

    Watch

    +

    watch changes to an object of kind IngressClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/networking.k8s.io/v1/watch/ingressclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the IngressClass
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of IngressClass. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/networking.k8s.io/v1/watch/ingressclasses +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Service v1 core

    + +
    +
    +
    Service Config to load balance traffic across all Pods with the app=nginx label. Receives on and sends to port 80. Exposes an externally accessible endpoint.
    +
    +
    
    +kind: Service
    +apiVersion: v1
    +metadata:
    +  # Unique key of the Service instance
    +  name: service-example
    +spec:
    +  ports:
    +    # Accept traffic sent to port 80
    +    - name: http
    +      port: 80
    +      targetPort: 80
    +  selector:
    +    # Loadbalance traffic across Pods matching
    +    # this label selector
    +    app: nginx
    +  # Create an HA proxy in the cloud provider
    +  # with an External IP address - *Only supported
    +  # by some cloud providers*
    +  type: LoadBalancer
    +
    +
    + + + + + +
    GroupVersionKind
    corev1Service
    +
    Appears In: + +
    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    spec
    ServiceSpec
    Spec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    status
    ServiceStatus
    Most recently observed status of the service. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    +

    ServiceSpec v1 core

    +
    Appears In: + +
    + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    allocateLoadBalancerNodePorts
    boolean
    allocateLoadBalancerNodePorts defines if NodePorts will be automatically allocated for services with type LoadBalancer. Default is "true". It may be set to "false" if the cluster load-balancer does not rely on NodePorts. allocateLoadBalancerNodePorts may only be set for services with type LoadBalancer and will be cleared if the type is changed to any other type. This field is alpha-level and is only honored by servers that enable the ServiceLBNodePortControl feature.
    clusterIP
    string
    clusterIP is the IP address of the service and is usually assigned randomly. If an address is specified manually, is in-range (as per system configuration), and is not in use, it will be allocated to the service; otherwise creation of the service will fail. This field may not be changed through updates unless the type field is also being changed to ExternalName (which requires this field to be blank) or the type field is being changed from ExternalName (in which case this field may optionally be specified, as describe above). Valid values are "None", empty string (""), or a valid IP address. Setting this to "None" makes a "headless service" (no virtual IP), which is useful when direct endpoint connections are preferred and proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. If this field is specified when creating a Service of type ExternalName, creation will fail. This field will be wiped when updating a Service to type ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
    clusterIPs
    string array
    ClusterIPs is a list of IP addresses assigned to this service, and are usually assigned randomly. If an address is specified manually, is in-range (as per system configuration), and is not in use, it will be allocated to the service; otherwise creation of the service will fail. This field may not be changed through updates unless the type field is also being changed to ExternalName (which requires this field to be empty) or the type field is being changed from ExternalName (in which case this field may optionally be specified, as describe above). Valid values are "None", empty string (""), or a valid IP address. Setting this to "None" makes a "headless service" (no virtual IP), which is useful when direct endpoint connections are preferred and proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. If this field is specified when creating a Service of type ExternalName, creation will fail. This field will be wiped when updating a Service to type ExternalName. If this field is not specified, it will be initialized from the clusterIP field. If this field is specified, clients must ensure that clusterIPs[0] and clusterIP have the same value. Unless the "IPv6DualStack" feature gate is enabled, this field is limited to one value, which must be the same as the clusterIP field. If the feature gate is enabled, this field may hold a maximum of two entries (dual-stack IPs, in either order). These IPs must correspond to the values of the ipFamilies field. Both clusterIPs and ipFamilies are governed by the ipFamilyPolicy field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
    externalIPs
    string array
    externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service. These IPs are not managed by Kubernetes. The user is responsible for ensuring that traffic arrives at a node with this IP. A common example is external load-balancers that are not part of the Kubernetes system.
    externalName
    string
    externalName is the external reference that discovery mechanisms will return as an alias for this service (e.g. a DNS CNAME record). No proxying will be involved. Must be a lowercase RFC-1123 hostname (https://tools.ietf.org/html/rfc1123) and requires `type` to be "ExternalName".
    externalTrafficPolicy
    string
    externalTrafficPolicy denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints. "Local" preserves the client source IP and avoids a second hop for LoadBalancer and Nodeport type services, but risks potentially imbalanced traffic spreading. "Cluster" obscures the client source IP and may cause a second hop to another node, but should have good overall load-spreading.
    healthCheckNodePort
    integer
    healthCheckNodePort specifies the healthcheck nodePort for the service. This only applies when type is set to LoadBalancer and externalTrafficPolicy is set to Local. If a value is specified, is in-range, and is not in use, it will be used. If not specified, a value will be automatically allocated. External systems (e.g. load-balancers) can use this port to determine if a given node holds endpoints for this service or not. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type).
    internalTrafficPolicy
    string
    InternalTrafficPolicy specifies if the cluster internal traffic should be routed to all endpoints or node-local endpoints only. "Cluster" routes internal traffic to a Service to all endpoints. "Local" routes traffic to node-local endpoints only, traffic is dropped if no node-local endpoints are ready. The default value is "Cluster".
    ipFamilies
    string array
    IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this service, and is gated by the "IPv6DualStack" feature gate. This field is usually assigned automatically based on cluster configuration and the ipFamilyPolicy field. If this field is specified manually, the requested family is available in the cluster, and ipFamilyPolicy allows it, it will be used; otherwise creation of the service will fail. This field is conditionally mutable: it allows for adding or removing a secondary IP family, but it does not allow changing the primary IP family of the Service. Valid values are "IPv4" and "IPv6". This field only applies to Services of types ClusterIP, NodePort, and LoadBalancer, and does apply to "headless" services. This field will be wiped when updating a Service to type ExternalName. This field may hold a maximum of two entries (dual-stack families, in either order). These families must correspond to the values of the clusterIPs field, if specified. Both clusterIPs and ipFamilies are governed by the ipFamilyPolicy field.
    ipFamilyPolicy
    string
    IPFamilyPolicy represents the dual-stack-ness requested or required by this Service, and is gated by the "IPv6DualStack" feature gate. If there is no value provided, then this field will be set to SingleStack. Services can be "SingleStack" (a single IP family), "PreferDualStack" (two IP families on dual-stack configured clusters or a single IP family on single-stack clusters), or "RequireDualStack" (two IP families on dual-stack configured clusters, otherwise fail). The ipFamilies and clusterIPs fields depend on the value of this field. This field will be wiped when updating a service to type ExternalName.
    loadBalancerClass
    string
    loadBalancerClass is the class of the load balancer implementation this Service belongs to. If specified, the value of this field must be a label-style identifier, with an optional prefix, e.g. "internal-vip" or "example.com/internal-vip". Unprefixed names are reserved for end-users. This field can only be set when the Service type is 'LoadBalancer'. If not set, the default load balancer implementation is used, today this is typically done through the cloud provider integration, but should apply for any default implementation. If set, it is assumed that a load balancer implementation is watching for Services with a matching class. Any default load balancer implementation (e.g. cloud providers) should ignore Services that set this field. This field can only be set when creating or updating a Service to type 'LoadBalancer'. Once set, it can not be changed. This field will be wiped when a service is updated to a non 'LoadBalancer' type.
    loadBalancerIP
    string
    Only applies to Service Type: LoadBalancer LoadBalancer will get created with the IP specified in this field. This feature depends on whether the underlying cloud-provider supports specifying the loadBalancerIP when a load balancer is created. This field will be ignored if the cloud-provider does not support the feature.
    loadBalancerSourceRanges
    string array
    If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature." More info: https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/
    ports
    ServicePort array
    patch strategy: merge
    patch merge key: port
    The list of ports that are exposed by this service. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
    publishNotReadyAddresses
    boolean
    publishNotReadyAddresses indicates that any agent which deals with endpoints for this Service should disregard any indications of ready/not-ready. The primary use case for setting this field is for a StatefulSet's Headless Service to propagate SRV DNS records for its Pods for the purpose of peer discovery. The Kubernetes controllers that generate Endpoints and EndpointSlice resources for Services interpret this to mean that all endpoints are considered "ready" even if the Pods themselves are not. Agents which consume only Kubernetes generated endpoints through the Endpoints or EndpointSlice resources can safely assume this behavior.
    selector
    object
    Route service traffic to pods with label keys and values matching this selector. If empty or not present, the service is assumed to have an external process managing its endpoints, which Kubernetes will not modify. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/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
    sessionAffinityConfig
    SessionAffinityConfig
    sessionAffinityConfig contains the configurations of session affinity.
    topologyKeys
    string array
    topologyKeys is a preference-order list of topology keys which implementations of services should use to preferentially sort endpoints when accessing this Service, it can not be used at the same time as externalTrafficPolicy=Local. Topology keys must be valid label keys and at most 16 keys may be specified. Endpoints are chosen based on the first topology key with available backends. If this field is specified and all entries have no backends that match the topology of the client, the service has no backends for that client and connections should fail. The special value "*" may be used to mean "any topology". This catch-all value, if used, only makes sense as the last value in the list. If this is not specified or empty, no topology constraints will be applied. This field is alpha-level and is only honored by servers that enable the ServiceTopology feature. This field is deprecated and will be removed in a future version.
    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
    +

    ServiceStatus v1 core

    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    conditions
    Condition array
    patch strategy: merge
    patch merge key: type
    Current service state
    loadBalancer
    LoadBalancerStatus
    LoadBalancer contains the current status of the load-balancer, if one is present.
    +

    ServiceList v1 core

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    Service array
    List of services
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    +

    Write Operations

    +

    Create

    + + +
    +
    +
    kubectl command
    +
    +
    
    +$ echo 'kind: Service
    +apiVersion: v1
    +metadata:
    +  name: service-example
    +spec:
    +  ports:
    +    - name: http
    +      port: 80
    +      targetPort: 80
    +  selector:
    +      app: nginx
    +  type: LoadBalancer
    +' | kubectl create -f -
    +
    +
    +
    +
    curl command (requires kubectl proxy to be running)
    +
    +
    
    +$ kubectl proxy
    +$ curl -X POST -H 'Content-Type: application/yaml' --data '
    +kind: Service
    +apiVersion: v1
    +metadata:
    +  name: service-example
    +spec:
    +  ports:
    +    - name: http
    +      port: 80
    +      targetPort: 80
    +  selector:
    +      app: nginx
    +  type: LoadBalancer
    +' http://127.0.0.1:8001/api/v1/namespaces/default/services
    +
    + + +
    +
    +
    Output
    +
    +
    
    +service "service-example" created
    +
    +
    +
    +
    Response Body
    +
    +
    
    +{
    +  "kind": "Service",
    +  "apiVersion": "v1",
    +  "metadata": {
    +    "name": "service-example",
    +    "namespace": "default",
    +    "selfLink": "/api/v1/namespaces/default/services/service-example",
    +    "uid": "93e5c731-9d30-11e6-9c54-42010a800148",
    +    "resourceVersion": "2205767",
    +    "creationTimestamp": "2016-10-28T17:04:24Z"
    +  },
    +  "spec": {
    +    "ports": [
    +      {
    +        "name": "http",
    +        "protocol": "TCP",
    +        "port": 80,
    +        "targetPort": 80,
    +        "nodePort": 32417
    +      }
    +    ],
    +    "selector": {
    +      "app": "nginx"
    +    },
    +    "clusterIP": "10.183.250.161",
    +    "type": "LoadBalancer",
    +    "sessionAffinity": "None"
    +  },
    +  "status": {
    +    "loadBalancer": {}
    +  }
    +}
    +
    +

    create a Service

    +

    HTTP Request

    +POST /api/v1/namespaces/{namespace}/services +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Service
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    Service
    OK
    201
    Service
    Created
    202
    Service
    Accepted
    +

    Patch

    + + +
    +
    +
    kubectl command
    +
    +
    
    +$ kubectl patch service  -p \
    +	'{"spec":{"ports":[{"name":"http","port":80,"targetPort":8080}]}}'
    +
    +
    +
    +
    curl command (requires kubectl proxy to be running)
    +
    +
    
    +$ kubectl proxy
    +$ curl -X PATCH -H 'Content-Type: application/strategic-merge-patch+json' --data '
    +{"spec":{"ports":[{"name":"http","port":80,"targetPort":8080}]}}' \
    +	'http://127.0.0.1:8001/api/v1/namespaces/default/services/'
    +
    + + +
    +
    +
    Output
    +
    +
    
    +"" patched
    +
    +
    +
    +
    Response Body
    +
    +
    
    +{
    +  "kind": "Service",
    +  "apiVersion": "v1",
    +  "metadata": {
    +    "name": "deployment-example",
    +    "namespace": "default",
    +    "selfLink": "/api/v1/namespaces/default/services/deployment-example",
    +    "uid": "93e5c731-9d30-11e6-9c54-42010a800148",
    +    "resourceVersion": "2205995",
    +    "creationTimestamp": "2016-10-28T17:04:24Z"
    +  },
    +  "spec": {
    +    "ports": [
    +      {
    +        "name": "http",
    +        "protocol": "TCP",
    +        "port": 80,
    +        "targetPort": 8080,
    +        "nodePort": 32417
    +      }
    +    ],
    +    "selector": {
    +      "app": "nginx"
    +    },
    +    "clusterIP": "10.183.250.161",
    +    "type": "LoadBalancer",
    +    "sessionAffinity": "None"
    +  },
    +  "status": {
    +    "loadBalancer": {
    +      "ingress": [
    +        {
    +          "ip": "104.198.186.106"
    +        }
    +      ]
    +    }
    +  }
    +}
    +
    +

    partially update the specified Service

    +

    HTTP Request

    +PATCH /api/v1/namespaces/{namespace}/services/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Service
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    Service
    OK
    +

    Replace

    + + +
    +
    +
    kubectl command
    +
    +
    
    +$ echo 'apiVersion: v1
    +kind: Service
    +metadata:
    +  name: deployment-example
    +  resourceVersion: "2205995"
    +spec:
    +  clusterIP: 10.183.250.161
    +  ports:
    +  - name: http
    +    nodePort: 32417
    +    port: 80
    +    protocol: TCP
    +    targetPort: 8080
    +  selector:
    +    app: nginx
    +  sessionAffinity: None
    +  type: LoadBalancer
    +' | kubectl replace -f -
    +
    +
    +
    +
    curl command (requires kubectl proxy to be running)
    +
    +
    
    +$ kubectl proxy
    +$ curl -X PUT -H 'Content-Type: application/yaml' --data '
    +apiVersion: v1
    +kind: Service
    +metadata:
    +  name: deployment-example
    +  resourceVersion: "2205995"
    +spec:
    +  clusterIP: 10.183.250.161
    +  ports:
    +  - name: http
    +    nodePort: 32417
    +    port: 80
    +    protocol: TCP
    +    targetPort: 8080
    +  selector:
    +    app: nginx
    +  sessionAffinity: None
    +  type: LoadBalancer
    +' http://127.0.0.1:8001/api/v1/namespaces/default/services/deployment-example
    +
    + + +
    +
    +
    Output
    +
    +
    
    +service "deployment-example" replaced
    +
    +
    +
    +
    Response Body
    +
    +
    
    +{
    +  "kind": "Service",
    +  "apiVersion": "v1",
    +  "metadata": {
    +    "name": "deployment-example",
    +    "namespace": "default",
    +    "selfLink": "/api/v1/namespaces/default/services/deployment-example",
    +    "uid": "93e5c731-9d30-11e6-9c54-42010a800148",
    +    "resourceVersion": "2208672",
    +    "creationTimestamp": "2016-10-28T17:04:24Z"
    +  },
    +  "spec": {
    +    "ports": [
    +      {
    +        "name": "http",
    +        "protocol": "TCP",
    +        "port": 80,
    +        "targetPort": 8080,
    +        "nodePort": 32417
    +      }
    +    ],
    +    "selector": {
    +      "app": "nginx"
    +    },
    +    "clusterIP": "10.183.250.161",
    +    "type": "LoadBalancer",
    +    "sessionAffinity": "None"
    +  },
    +  "status": {
    +    "loadBalancer": {
    +      "ingress": [
    +        {
    +          "ip": "104.198.186.106"
    +        }
    +      ]
    +    }
    +  }
    +}
    +
    +

    replace the specified Service

    +

    HTTP Request

    +PUT /api/v1/namespaces/{namespace}/services/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Service
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Service
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Service
    OK
    201
    Service
    Created
    +

    Delete

    + + +
    +
    +
    kubectl command
    +
    +
    
    +$ kubectl delete service deployment-example
    +
    +
    +
    +
    curl command (requires kubectl proxy to be running)
    +
    +
    
    +$ kubectl proxy
    +$ curl -X DELETE -H 'Content-Type: application/yaml' --data '
    +gracePeriodSeconds: 0
    +orphanDependents: false
    +' 'http://127.0.0.1:8001/api/v1/namespaces/default/services/deployment-example'
    +
    + + +
    +
    +
    Output
    +
    +
    
    +service "deployment-example" deleted
    +
    +
    +
    +
    Response Body
    +
    +
    
    +{
    +  "kind": "Status",
    +  "apiVersion": "v1",
    +  "metadata": {},
    +  "status": "Success",
    +  "code": 200
    +}
    +
    +
    +

    delete a Service

    +

    HTTP Request

    +DELETE /api/v1/namespaces/{namespace}/services/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Service
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Read Operations

    +

    Read

    + + +
    +
    +
    kubectl command
    +
    +
    
    +$ kubectl get service deployment-example -o json
    +
    +
    +
    +
    curl command (requires kubectl proxy to be running)
    +
    +
    
    +$ kubectl proxy
    +$ curl -X GET http://127.0.0.1:8001/api/v1/namespaces/default/services/deployment-example
    +
    + + +
    +
    +
    Output
    +
    +
    
    +{
    +  "kind": "Service",
    +  "apiVersion": "v1",
    +  "metadata": {
    +    "name": "deployment-example",
    +    "namespace": "default",
    +    "selfLink": "/api/v1/namespaces/default/services/deployment-example",
    +    "uid": "93e5c731-9d30-11e6-9c54-42010a800148",
    +    "resourceVersion": "2205995",
    +    "creationTimestamp": "2016-10-28T17:04:24Z"
    +  },
    +  "spec": {
    +    "ports": [
    +      {
    +        "name": "http",
    +        "protocol": "TCP",
    +        "port": 80,
    +        "targetPort": 8080,
    +        "nodePort": 32417
    +      }
    +    ],
    +    "selector": {
    +      "app": "nginx"
    +    },
    +    "clusterIP": "10.183.250.161",
    +    "type": "LoadBalancer",
    +    "sessionAffinity": "None"
    +  },
    +  "status": {
    +    "loadBalancer": {
    +      "ingress": [
    +        {
    +          "ip": "104.198.186.106"
    +        }
    +      ]
    +    }
    +  }
    +}
    +
    +
    +
    +
    Response Body
    +
    +
    
    +{
    +  "kind": "Service",
    +  "apiVersion": "v1",
    +  "metadata": {
    +    "name": "deployment-example",
    +    "namespace": "default",
    +    "selfLink": "/api/v1/namespaces/default/services/deployment-example",
    +    "uid": "93e5c731-9d30-11e6-9c54-42010a800148",
    +    "resourceVersion": "2205995",
    +    "creationTimestamp": "2016-10-28T17:04:24Z"
    +  },
    +  "spec": {
    +    "ports": [
    +      {
    +        "name": "http",
    +        "protocol": "TCP",
    +        "port": 80,
    +        "targetPort": 8080,
    +        "nodePort": 32417
    +      }
    +    ],
    +    "selector": {
    +      "app": "nginx"
    +    },
    +    "clusterIP": "10.183.250.161",
    +    "type": "LoadBalancer",
    +    "sessionAffinity": "None"
    +  },
    +  "status": {
    +    "loadBalancer": {
    +      "ingress": [
    +        {
    +          "ip": "104.198.186.106"
    +        }
    +      ]
    +    }
    +  }
    +}
    +
    +

    read the specified Service

    +

    HTTP Request

    +GET /api/v1/namespaces/{namespace}/services/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Service
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    Service
    OK
    +

    List

    + + +
    +
    +
    kubectl command
    +
    +
    
    +$ kubectl get service -o json
    +
    +
    +
    +
    curl command (requires kubectl proxy to be running)
    +
    +
    
    +$ kubectl proxy
    +$ curl -X GET 'http://127.0.0.1:8001/api/v1/namespaces/default/services'
    +
    +

    list or watch objects of kind Service

    +

    HTTP Request

    +GET /api/v1/namespaces/{namespace}/services +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    ServiceList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind Service

    +

    HTTP Request

    +GET /api/v1/services +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    ServiceList
    OK
    +

    Watch

    + + +
    +
    +
    kubectl command
    +
    +
    
    +$ kubectl get service deployment-example --watch -o json
    +
    +
    +
    +
    curl command (requires kubectl proxy to be running)
    +
    +
    
    +$ kubectl proxy
    +$ curl -X GET 'http://127.0.0.1:8001/api/v1/watch/namespaces/default/services/deployment-example'
    +
    + + +
    +
    +
    Output
    +
    +
    
    +{
    +	"type": "ADDED",
    +	"object": {
    +		"kind": "Service",
    +		"apiVersion": "v1",
    +		"metadata": {
    +			"name": "deployment-example",
    +			"namespace": "default",
    +			"selfLink": "/api/v1/namespaces/default/services/deployment-example",
    +			"uid": "93e5c731-9d30-11e6-9c54-42010a800148",
    +			"resourceVersion": "2205995",
    +			"creationTimestamp": "2016-10-28T17:04:24Z"
    +		},
    +		"spec": {
    +			"ports": [
    +				{
    +					"name": "http",
    +					"protocol": "TCP",
    +					"port": 80,
    +					"targetPort": 8080,
    +					"nodePort": 32417
    +				}
    +			],
    +			"selector": {
    +				"app": "nginx"
    +			},
    +			"clusterIP": "10.183.250.161",
    +			"type": "LoadBalancer",
    +			"sessionAffinity": "None"
    +		},
    +		"status": {
    +			"loadBalancer": {
    +				"ingress": [
    +					{
    +						"ip": "104.198.186.106"
    +					}
    +				]
    +			}
    +		}
    +	}
    +}
    +
    +
    +
    +
    Response Body
    +
    +
    
    +{
    +	"type": "ADDED",
    +	"object": {
    +		"kind": "Service",
    +		"apiVersion": "v1",
    +		"metadata": {
    +			"name": "deployment-example",
    +			"namespace": "default",
    +			"selfLink": "/api/v1/namespaces/default/services/deployment-example",
    +			"uid": "93e5c731-9d30-11e6-9c54-42010a800148",
    +			"resourceVersion": "2205995",
    +			"creationTimestamp": "2016-10-28T17:04:24Z"
    +		},
    +		"spec": {
    +			"ports": [
    +				{
    +					"name": "http",
    +					"protocol": "TCP",
    +					"port": 80,
    +					"targetPort": 8080,
    +					"nodePort": 32417
    +				}
    +			],
    +			"selector": {
    +				"app": "nginx"
    +			},
    +			"clusterIP": "10.183.250.161",
    +			"type": "LoadBalancer",
    +			"sessionAffinity": "None"
    +		},
    +		"status": {
    +			"loadBalancer": {
    +				"ingress": [
    +					{
    +						"ip": "104.198.186.106"
    +					}
    +				]
    +			}
    +		}
    +	}
    +}
    +
    +

    watch changes to an object of kind Service. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /api/v1/watch/namespaces/{namespace}/services/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Service
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of Service. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /api/v1/watch/namespaces/{namespace}/services +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of Service. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /api/v1/watch/services +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Status Operations

    +

    Patch Status

    +

    partially update status of the specified Service

    +

    HTTP Request

    +PATCH /api/v1/namespaces/{namespace}/services/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Service
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    Service
    OK
    +

    Read Status

    +

    read status of the specified Service

    +

    HTTP Request

    +GET /api/v1/namespaces/{namespace}/services/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Service
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    Service
    OK
    +

    Replace Status

    +

    replace status of the specified Service

    +

    HTTP Request

    +PUT /api/v1/namespaces/{namespace}/services/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Service
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Service
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Service
    OK
    201
    Service
    Created
    +

    Proxy Operations

    +

    Create Connect Proxy

    +

    connect POST requests to proxy of Service

    +

    HTTP Request

    +POST /api/v1/namespaces/{namespace}/services/{name}/proxy +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ServiceProxyOptions
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    pathPath is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
    +

    Response

    + + + + + +
    CodeDescription
    200
    string
    OK
    +

    Create Connect Proxy Path

    +

    connect POST requests to proxy of Service

    +

    HTTP Request

    +POST /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} +

    Path Parameters

    + + + + + + + +
    ParameterDescription
    namename of the ServiceProxyOptions
    namespaceobject name and auth scope, such as for teams and projects
    pathpath to the resource
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    pathPath is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
    +

    Response

    + + + + + +
    CodeDescription
    200
    string
    OK
    +

    Delete Connect Proxy

    +

    connect DELETE requests to proxy of Service

    +

    HTTP Request

    +DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ServiceProxyOptions
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    pathPath is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
    +

    Response

    + + + + + +
    CodeDescription
    200
    string
    OK
    +

    Delete Connect Proxy Path

    +

    connect DELETE requests to proxy of Service

    +

    HTTP Request

    +DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} +

    Path Parameters

    + + + + + + + +
    ParameterDescription
    namename of the ServiceProxyOptions
    namespaceobject name and auth scope, such as for teams and projects
    pathpath to the resource
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    pathPath is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
    +

    Response

    + + + + + +
    CodeDescription
    200
    string
    OK
    +

    Get Connect Proxy

    +

    connect GET requests to proxy of Service

    +

    HTTP Request

    +GET /api/v1/namespaces/{namespace}/services/{name}/proxy +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ServiceProxyOptions
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    pathPath is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
    +

    Response

    + + + + + +
    CodeDescription
    200
    string
    OK
    +

    Get Connect Proxy Path

    +

    connect GET requests to proxy of Service

    +

    HTTP Request

    +GET /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} +

    Path Parameters

    + + + + + + + +
    ParameterDescription
    namename of the ServiceProxyOptions
    namespaceobject name and auth scope, such as for teams and projects
    pathpath to the resource
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    pathPath is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
    +

    Response

    + + + + + +
    CodeDescription
    200
    string
    OK
    +

    Head Connect Proxy

    +

    connect HEAD requests to proxy of Service

    +

    HTTP Request

    +HEAD /api/v1/namespaces/{namespace}/services/{name}/proxy +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ServiceProxyOptions
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    pathPath is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
    +

    Response

    + + + + + +
    CodeDescription
    200
    string
    OK
    +

    Head Connect Proxy Path

    +

    connect HEAD requests to proxy of Service

    +

    HTTP Request

    +HEAD /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} +

    Path Parameters

    + + + + + + + +
    ParameterDescription
    namename of the ServiceProxyOptions
    namespaceobject name and auth scope, such as for teams and projects
    pathpath to the resource
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    pathPath is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
    +

    Response

    + + + + + +
    CodeDescription
    200
    string
    OK
    +

    Replace Connect Proxy

    +

    connect PUT requests to proxy of Service

    +

    HTTP Request

    +PUT /api/v1/namespaces/{namespace}/services/{name}/proxy +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ServiceProxyOptions
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    pathPath is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
    +

    Response

    + + + + + +
    CodeDescription
    200
    string
    OK
    +

    Replace Connect Proxy Path

    +

    connect PUT requests to proxy of Service

    +

    HTTP Request

    +PUT /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} +

    Path Parameters

    + + + + + + + +
    ParameterDescription
    namename of the ServiceProxyOptions
    namespaceobject name and auth scope, such as for teams and projects
    pathpath to the resource
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    pathPath is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
    +

    Response

    + + + + + +
    CodeDescription
    200
    string
    OK
    +

    CONFIG & STORAGE

    + +

    Config and Storage resources are responsible for injecting data into your applications and persisting data externally to your container.

    + +

    Common resource types:

    +
      +
    • ConfigMaps for providing text key value pairs injected into the application through environment variables, command line arguments, or files
    • +
    • Secrets for providing binary data injected into the application through files
    • +
    • Volumes for providing a filesystem external to the Container. Maybe shared across Containers within the same Pod and have a lifetime persisting beyond a Container or Pod.
    • +
    +
    +

    ConfigMap v1 core

    + + + + + +
    GroupVersionKind
    corev1ConfigMap
    +
    Appears In: + +
    + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    binaryData
    object
    BinaryData contains the binary data. Each key must consist of alphanumeric characters, '-', '_' or '.'. BinaryData can contain byte sequences that are not in the UTF-8 range. The keys stored in BinaryData must not overlap with the ones in the Data field, this is enforced during validation process. Using this field will require 1.10+ apiserver and kubelet.
    data
    object
    Data contains the configuration data. Each key must consist of alphanumeric characters, '-', '_' or '.'. Values with non-UTF-8 byte sequences must use the BinaryData field. The keys stored in Data must not overlap with the keys in the BinaryData field, this is enforced during validation process.
    immutable
    boolean
    Immutable, if set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    +

    ConfigMapList v1 core

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    ConfigMap array
    Items is the list of ConfigMaps.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    +

    Write Operations

    +

    Create

    +

    create a ConfigMap

    +

    HTTP Request

    +POST /api/v1/namespaces/{namespace}/configmaps +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    ConfigMap
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    ConfigMap
    OK
    201
    ConfigMap
    Created
    202
    ConfigMap
    Accepted
    +

    Patch

    +

    partially update the specified ConfigMap

    +

    HTTP Request

    +PATCH /api/v1/namespaces/{namespace}/configmaps/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ConfigMap
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    ConfigMap
    OK
    +

    Replace

    +

    replace the specified ConfigMap

    +

    HTTP Request

    +PUT /api/v1/namespaces/{namespace}/configmaps/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ConfigMap
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    ConfigMap
    +

    Response

    + + + + + + +
    CodeDescription
    200
    ConfigMap
    OK
    201
    ConfigMap
    Created
    +

    Delete

    +

    delete a ConfigMap

    +

    HTTP Request

    +DELETE /api/v1/namespaces/{namespace}/configmaps/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ConfigMap
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of ConfigMap

    +

    HTTP Request

    +DELETE /api/v1/namespaces/{namespace}/configmaps +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified ConfigMap

    +

    HTTP Request

    +GET /api/v1/namespaces/{namespace}/configmaps/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ConfigMap
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    ConfigMap
    OK
    +

    List

    +

    list or watch objects of kind ConfigMap

    +

    HTTP Request

    +GET /api/v1/namespaces/{namespace}/configmaps +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    ConfigMapList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind ConfigMap

    +

    HTTP Request

    +GET /api/v1/configmaps +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    ConfigMapList
    OK
    +

    Watch

    +

    watch changes to an object of kind ConfigMap. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /api/v1/watch/namespaces/{namespace}/configmaps/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ConfigMap
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of ConfigMap. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /api/v1/watch/namespaces/{namespace}/configmaps +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of ConfigMap. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /api/v1/watch/configmaps +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    CSIDriver v1 storage.k8s.io

    + + + + + +
    GroupVersionKind
    storage.k8s.iov1CSIDriver
    +
    Other API versions of this object exist: +v1beta1 +
    +
    Appears In: + +
    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object metadata. metadata.Name indicates the name of the CSI driver that this object refers to; it MUST be the same name returned by the CSI GetPluginName() call for that driver. The driver name must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), dots (.), and alphanumerics between. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    spec
    CSIDriverSpec
    Specification of the CSI Driver.
    +

    CSIDriverSpec v1 storage

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

    CSIDriverList v1 storage

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    CSIDriver array
    items is the list of CSIDriver
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    +

    Write Operations

    +

    Create

    +

    create a CSIDriver

    +

    HTTP Request

    +POST /apis/storage.k8s.io/v1/csidrivers +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    CSIDriver
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    CSIDriver
    OK
    201
    CSIDriver
    Created
    202
    CSIDriver
    Accepted
    +

    Patch

    +

    partially update the specified CSIDriver

    +

    HTTP Request

    +PATCH /apis/storage.k8s.io/v1/csidrivers/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CSIDriver
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    CSIDriver
    OK
    +

    Replace

    +

    replace the specified CSIDriver

    +

    HTTP Request

    +PUT /apis/storage.k8s.io/v1/csidrivers/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CSIDriver
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    CSIDriver
    +

    Response

    + + + + + + +
    CodeDescription
    200
    CSIDriver
    OK
    201
    CSIDriver
    Created
    +

    Delete

    +

    delete a CSIDriver

    +

    HTTP Request

    +DELETE /apis/storage.k8s.io/v1/csidrivers/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CSIDriver
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    CSIDriver
    OK
    202
    CSIDriver
    Accepted
    +

    Delete Collection

    +

    delete collection of CSIDriver

    +

    HTTP Request

    +DELETE /apis/storage.k8s.io/v1/csidrivers +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified CSIDriver

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1/csidrivers/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CSIDriver
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    CSIDriver
    OK
    +

    List

    +

    list or watch objects of kind CSIDriver

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1/csidrivers +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    CSIDriverList
    OK
    +

    Watch

    +

    watch changes to an object of kind CSIDriver. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1/watch/csidrivers/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CSIDriver
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of CSIDriver. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1/watch/csidrivers +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    CSINode v1 storage.k8s.io

    + + + + + +
    GroupVersionKind
    storage.k8s.iov1CSINode
    +
    Other API versions of this object exist: +v1beta1 +
    +
    Appears In: + +
    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    metadata.name must be the Kubernetes node name.
    spec
    CSINodeSpec
    spec is the specification of CSINode
    +

    CSINodeSpec v1 storage

    +
    Appears In: + +
    + + + + + +
    FieldDescription
    drivers
    CSINodeDriver array
    patch strategy: merge
    patch merge key: name
    drivers is a list of information of all CSI Drivers existing on a node. If all drivers in the list are uninstalled, this can become empty.
    +

    CSINodeList v1 storage

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    CSINode array
    items is the list of CSINode
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    +

    Write Operations

    +

    Create

    +

    create a CSINode

    +

    HTTP Request

    +POST /apis/storage.k8s.io/v1/csinodes +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    CSINode
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    CSINode
    OK
    201
    CSINode
    Created
    202
    CSINode
    Accepted
    +

    Patch

    +

    partially update the specified CSINode

    +

    HTTP Request

    +PATCH /apis/storage.k8s.io/v1/csinodes/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CSINode
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    CSINode
    OK
    +

    Replace

    +

    replace the specified CSINode

    +

    HTTP Request

    +PUT /apis/storage.k8s.io/v1/csinodes/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CSINode
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    CSINode
    +

    Response

    + + + + + + +
    CodeDescription
    200
    CSINode
    OK
    201
    CSINode
    Created
    +

    Delete

    +

    delete a CSINode

    +

    HTTP Request

    +DELETE /apis/storage.k8s.io/v1/csinodes/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CSINode
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    CSINode
    OK
    202
    CSINode
    Accepted
    +

    Delete Collection

    +

    delete collection of CSINode

    +

    HTTP Request

    +DELETE /apis/storage.k8s.io/v1/csinodes +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified CSINode

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1/csinodes/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CSINode
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    CSINode
    OK
    +

    List

    +

    list or watch objects of kind CSINode

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1/csinodes +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    CSINodeList
    OK
    +

    Watch

    +

    watch changes to an object of kind CSINode. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1/watch/csinodes/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CSINode
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of CSINode. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1/watch/csinodes +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Secret v1 core

    + + + + + +
    GroupVersionKind
    corev1Secret
    +
    Appears In: + +
    + + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    data
    object
    Data contains the secret data. Each key must consist of alphanumeric characters, '-', '_' or '.'. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in https://tools.ietf.org/html/rfc4648#section-4
    immutable
    boolean
    Immutable, if set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    stringData
    object
    stringData allows specifying non-binary secret data in string form. It is provided as a write-only input field for convenience. All keys and values are merged into the data field on write, overwriting any existing values. The stringData field is never output when reading from the API.
    type
    string
    Used to facilitate programmatic handling of secret data.
    +

    SecretList v1 core

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    Secret array
    Items is a list of secret objects. More info: https://kubernetes.io/docs/concepts/configuration/secret
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    +

    Write Operations

    +

    Create

    +

    create a Secret

    +

    HTTP Request

    +POST /api/v1/namespaces/{namespace}/secrets +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Secret
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    Secret
    OK
    201
    Secret
    Created
    202
    Secret
    Accepted
    +

    Patch

    +

    partially update the specified Secret

    +

    HTTP Request

    +PATCH /api/v1/namespaces/{namespace}/secrets/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Secret
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    Secret
    OK
    +

    Replace

    +

    replace the specified Secret

    +

    HTTP Request

    +PUT /api/v1/namespaces/{namespace}/secrets/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Secret
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Secret
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Secret
    OK
    201
    Secret
    Created
    +

    Delete

    +

    delete a Secret

    +

    HTTP Request

    +DELETE /api/v1/namespaces/{namespace}/secrets/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Secret
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of Secret

    +

    HTTP Request

    +DELETE /api/v1/namespaces/{namespace}/secrets +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified Secret

    +

    HTTP Request

    +GET /api/v1/namespaces/{namespace}/secrets/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Secret
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    Secret
    OK
    +

    List

    +

    list or watch objects of kind Secret

    +

    HTTP Request

    +GET /api/v1/namespaces/{namespace}/secrets +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    SecretList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind Secret

    +

    HTTP Request

    +GET /api/v1/secrets +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    SecretList
    OK
    +

    Watch

    +

    watch changes to an object of kind Secret. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /api/v1/watch/namespaces/{namespace}/secrets/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Secret
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of Secret. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /api/v1/watch/namespaces/{namespace}/secrets +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of Secret. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /api/v1/watch/secrets +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    PersistentVolumeClaim v1 core

    + + + + + +
    GroupVersionKind
    corev1PersistentVolumeClaim
    +
    A PersistentVolume must be allocated in the cluster to use this.
    + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    spec
    PersistentVolumeClaimSpec
    Spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
    status
    PersistentVolumeClaimStatus
    Status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
    +

    PersistentVolumeClaimSpec v1 core

    + + + + + + + + + + + + +
    FieldDescription
    accessModes
    string array
    AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
    dataSource
    TypedLocalObjectReference
    This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) * An existing custom resource that implements data population (Alpha) In order to use custom resource types that implement data population, the AnyVolumeDataSource feature gate must be enabled. If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source.
    resources
    ResourceRequirements
    Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
    selector
    LabelSelector
    A label query over volumes to consider for binding.
    storageClassName
    string
    Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
    volumeMode
    string
    volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
    volumeName
    string
    VolumeName is the binding reference to the PersistentVolume backing this claim.
    +

    PersistentVolumeClaimStatus v1 core

    +
    Appears In: + +
    + + + + + + + + +
    FieldDescription
    accessModes
    string array
    AccessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
    capacity
    object
    Represents the actual resources of the underlying volume.
    conditions
    PersistentVolumeClaimCondition array
    patch strategy: merge
    patch merge key: type
    Current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'.
    phase
    string
    Phase represents the current phase of PersistentVolumeClaim.
    +

    PersistentVolumeClaimList v1 core

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    PersistentVolumeClaim array
    A list of persistent volume claims. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    +

    Write Operations

    +

    Create

    +

    create a PersistentVolumeClaim

    +

    HTTP Request

    +POST /api/v1/namespaces/{namespace}/persistentvolumeclaims +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    PersistentVolumeClaim
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    PersistentVolumeClaim
    OK
    201
    PersistentVolumeClaim
    Created
    202
    PersistentVolumeClaim
    Accepted
    +

    Patch

    +

    partially update the specified PersistentVolumeClaim

    +

    HTTP Request

    +PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the PersistentVolumeClaim
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    PersistentVolumeClaim
    OK
    +

    Replace

    +

    replace the specified PersistentVolumeClaim

    +

    HTTP Request

    +PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the PersistentVolumeClaim
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    PersistentVolumeClaim
    +

    Response

    + + + + + + +
    CodeDescription
    200
    PersistentVolumeClaim
    OK
    201
    PersistentVolumeClaim
    Created
    +

    Delete

    +

    delete a PersistentVolumeClaim

    +

    HTTP Request

    +DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the PersistentVolumeClaim
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    PersistentVolumeClaim
    OK
    202
    PersistentVolumeClaim
    Accepted
    +

    Delete Collection

    +

    delete collection of PersistentVolumeClaim

    +

    HTTP Request

    +DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified PersistentVolumeClaim

    +

    HTTP Request

    +GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the PersistentVolumeClaim
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    PersistentVolumeClaim
    OK
    +

    List

    +

    list or watch objects of kind PersistentVolumeClaim

    +

    HTTP Request

    +GET /api/v1/namespaces/{namespace}/persistentvolumeclaims +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    PersistentVolumeClaimList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind PersistentVolumeClaim

    +

    HTTP Request

    +GET /api/v1/persistentvolumeclaims +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    PersistentVolumeClaimList
    OK
    +

    Watch

    +

    watch changes to an object of kind PersistentVolumeClaim. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the PersistentVolumeClaim
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of PersistentVolumeClaim. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of PersistentVolumeClaim. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /api/v1/watch/persistentvolumeclaims +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Status Operations

    +

    Patch Status

    +

    partially update status of the specified PersistentVolumeClaim

    +

    HTTP Request

    +PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the PersistentVolumeClaim
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    PersistentVolumeClaim
    OK
    +

    Read Status

    +

    read status of the specified PersistentVolumeClaim

    +

    HTTP Request

    +GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the PersistentVolumeClaim
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    PersistentVolumeClaim
    OK
    +

    Replace Status

    +

    replace status of the specified PersistentVolumeClaim

    +

    HTTP Request

    +PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the PersistentVolumeClaim
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    PersistentVolumeClaim
    +

    Response

    + + + + + + +
    CodeDescription
    200
    PersistentVolumeClaim
    OK
    201
    PersistentVolumeClaim
    Created
    +

    StorageClass v1 storage.k8s.io

    + + + + + +
    GroupVersionKind
    storage.k8s.iov1StorageClass
    +
    Other API versions of this object exist: +v1beta1 +
    +
    Appears In: + +
    + + + + + + + + + + + + + + +
    FieldDescription
    allowVolumeExpansion
    boolean
    AllowVolumeExpansion shows whether the storage class allow volume expand
    allowedTopologies
    TopologySelectorTerm array
    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.
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    mountOptions
    string array
    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.
    parameters
    object
    Parameters holds the parameters for the provisioner that should create volumes of this storage class.
    provisioner
    string
    Provisioner indicates the type of the provisioner.
    reclaimPolicy
    string
    Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. 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.
    +

    StorageClassList v1 storage

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    StorageClass array
    Items is the list of StorageClasses
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    +

    Write Operations

    +

    Create

    +

    create a StorageClass

    +

    HTTP Request

    +POST /apis/storage.k8s.io/v1/storageclasses +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    StorageClass
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    StorageClass
    OK
    201
    StorageClass
    Created
    202
    StorageClass
    Accepted
    +

    Patch

    +

    partially update the specified StorageClass

    +

    HTTP Request

    +PATCH /apis/storage.k8s.io/v1/storageclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the StorageClass
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    StorageClass
    OK
    +

    Replace

    +

    replace the specified StorageClass

    +

    HTTP Request

    +PUT /apis/storage.k8s.io/v1/storageclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the StorageClass
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    StorageClass
    +

    Response

    + + + + + + +
    CodeDescription
    200
    StorageClass
    OK
    201
    StorageClass
    Created
    +

    Delete

    +

    delete a StorageClass

    +

    HTTP Request

    +DELETE /apis/storage.k8s.io/v1/storageclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the StorageClass
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    StorageClass
    OK
    202
    StorageClass
    Accepted
    +

    Delete Collection

    +

    delete collection of StorageClass

    +

    HTTP Request

    +DELETE /apis/storage.k8s.io/v1/storageclasses +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified StorageClass

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1/storageclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the StorageClass
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    StorageClass
    OK
    +

    List

    +

    list or watch objects of kind StorageClass

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1/storageclasses +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    StorageClassList
    OK
    +

    Watch

    +

    watch changes to an object of kind StorageClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1/watch/storageclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the StorageClass
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of StorageClass. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1/watch/storageclasses +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Volume v1 core

    + + + + + +
    GroupVersionKind
    corev1Volume
    +
    Appears In: + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    awsElasticBlockStore
    AWSElasticBlockStoreVolumeSource
    AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
    azureDisk
    AzureDiskVolumeSource
    AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
    azureFile
    AzureFileVolumeSource
    AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
    cephfs
    CephFSVolumeSource
    CephFS represents a Ceph FS mount on the host that shares a pod's lifetime
    cinder
    CinderVolumeSource
    Cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
    configMap
    ConfigMapVolumeSource
    ConfigMap represents a configMap that should populate this volume
    csi
    CSIVolumeSource
    CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
    downwardAPI
    DownwardAPIVolumeSource
    DownwardAPI represents downward API about the pod that should populate this volume
    emptyDir
    EmptyDirVolumeSource
    EmptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
    ephemeral
    EphemeralVolumeSource
    Ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time. This is a beta feature and only available when the GenericEphemeralVolume feature gate is enabled.
    fc
    FCVolumeSource
    FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
    flexVolume
    FlexVolumeSource
    FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
    flocker
    FlockerVolumeSource
    Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
    gcePersistentDisk
    GCEPersistentDiskVolumeSource
    GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
    gitRepo
    GitRepoVolumeSource
    GitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.
    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
    hostPath
    HostPathVolumeSource
    HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
    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
    name
    string
    Volume's name. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
    nfs
    NFSVolumeSource
    NFS represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
    persistentVolumeClaim
    PersistentVolumeClaimVolumeSource
    PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
    photonPersistentDisk
    PhotonPersistentDiskVolumeSource
    PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
    portworxVolume
    PortworxVolumeSource
    PortworxVolume represents a portworx volume attached and mounted on kubelets host machine
    projected
    ProjectedVolumeSource
    Items for all in one resources secrets, configmaps, and downward API
    quobyte
    QuobyteVolumeSource
    Quobyte represents a Quobyte mount on the host that shares a pod's lifetime
    rbd
    RBDVolumeSource
    RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md
    scaleIO
    ScaleIOVolumeSource
    ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
    secret
    SecretVolumeSource
    Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
    storageos
    StorageOSVolumeSource
    StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
    vsphereVolume
    VsphereVirtualDiskVolumeSource
    VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
    +

    VolumeAttachment v1 storage.k8s.io

    + + + + + +
    GroupVersionKind
    storage.k8s.iov1VolumeAttachment
    +
    Other API versions of this object exist: +v1beta1 +v1alpha1 +
    + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    spec
    VolumeAttachmentSpec
    Specification of the desired attach/detach volume behavior. Populated by the Kubernetes system.
    status
    VolumeAttachmentStatus
    Status of the VolumeAttachment request. Populated by the entity completing the attach or detach operation, i.e. the external-attacher.
    +

    VolumeAttachmentSpec v1 storage

    +
    Appears In: + +
    + + + + + + + +
    FieldDescription
    attacher
    string
    Attacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName().
    nodeName
    string
    The node that the volume should be attached to.
    source
    VolumeAttachmentSource
    Source represents the volume that should be attached.
    +

    VolumeAttachmentStatus v1 storage

    +
    Appears In: + +
    + + + + + + + + +
    FieldDescription
    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.
    attached
    boolean
    Indicates the volume is successfully attached. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
    attachmentMetadata
    object
    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.
    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.
    +

    VolumeAttachmentList v1 storage

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    VolumeAttachment array
    Items is the list of VolumeAttachments
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    +

    Write Operations

    +

    Create

    +

    create a VolumeAttachment

    +

    HTTP Request

    +POST /apis/storage.k8s.io/v1/volumeattachments +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    VolumeAttachment
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    VolumeAttachment
    OK
    201
    VolumeAttachment
    Created
    202
    VolumeAttachment
    Accepted
    +

    Patch

    +

    partially update the specified VolumeAttachment

    +

    HTTP Request

    +PATCH /apis/storage.k8s.io/v1/volumeattachments/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the VolumeAttachment
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    VolumeAttachment
    OK
    +

    Replace

    +

    replace the specified VolumeAttachment

    +

    HTTP Request

    +PUT /apis/storage.k8s.io/v1/volumeattachments/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the VolumeAttachment
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    VolumeAttachment
    +

    Response

    + + + + + + +
    CodeDescription
    200
    VolumeAttachment
    OK
    201
    VolumeAttachment
    Created
    +

    Delete

    +

    delete a VolumeAttachment

    +

    HTTP Request

    +DELETE /apis/storage.k8s.io/v1/volumeattachments/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the VolumeAttachment
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    VolumeAttachment
    OK
    202
    VolumeAttachment
    Accepted
    +

    Delete Collection

    +

    delete collection of VolumeAttachment

    +

    HTTP Request

    +DELETE /apis/storage.k8s.io/v1/volumeattachments +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified VolumeAttachment

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1/volumeattachments/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the VolumeAttachment
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    VolumeAttachment
    OK
    +

    List

    +

    list or watch objects of kind VolumeAttachment

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1/volumeattachments +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    VolumeAttachmentList
    OK
    +

    Watch

    +

    watch changes to an object of kind VolumeAttachment. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1/watch/volumeattachments/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the VolumeAttachment
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of VolumeAttachment. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1/watch/volumeattachments +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Status Operations

    +

    Patch Status

    +

    partially update status of the specified VolumeAttachment

    +

    HTTP Request

    +PATCH /apis/storage.k8s.io/v1/volumeattachments/{name}/status +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the VolumeAttachment
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    VolumeAttachment
    OK
    +

    Read Status

    +

    read status of the specified VolumeAttachment

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1/volumeattachments/{name}/status +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the VolumeAttachment
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    VolumeAttachment
    OK
    +

    Replace Status

    +

    replace status of the specified VolumeAttachment

    +

    HTTP Request

    +PUT /apis/storage.k8s.io/v1/volumeattachments/{name}/status +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the VolumeAttachment
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    VolumeAttachment
    +

    Response

    + + + + + + +
    CodeDescription
    200
    VolumeAttachment
    OK
    201
    VolumeAttachment
    Created
    +

    METADATA

    + +

    Metadata resources are responsible for configuring behavior of your other Resources within the Cluster.

    + +

    Common resource types:

    +
      +
    • HorizontalPodAutoscaler (HPA) for automatically scaling the replicacount of your workloads in response to load.
    • +
    • PodDisruptionBudget for configuring how many replicas in a given workload maybe made concurrently unavailable when performing maintenance.
    • +
    • Event for notification of resource lifecycle events in the cluster.
    • +
    +
    +

    ControllerRevision v1 apps

    + + + + + +
    GroupVersionKind
    appsv1ControllerRevision
    + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    dataData is the serialized representation of the state.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    revision
    integer
    Revision indicates the revision of the state represented by Data.
    +

    ControllerRevisionList v1 apps

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    ControllerRevision array
    Items is the list of ControllerRevisions
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    +

    Write Operations

    +

    Create

    +

    create a ControllerRevision

    +

    HTTP Request

    +POST /apis/apps/v1/namespaces/{namespace}/controllerrevisions +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    ControllerRevision
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    ControllerRevision
    OK
    201
    ControllerRevision
    Created
    202
    ControllerRevision
    Accepted
    +

    Patch

    +

    partially update the specified ControllerRevision

    +

    HTTP Request

    +PATCH /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ControllerRevision
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    ControllerRevision
    OK
    +

    Replace

    +

    replace the specified ControllerRevision

    +

    HTTP Request

    +PUT /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ControllerRevision
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    ControllerRevision
    +

    Response

    + + + + + + +
    CodeDescription
    200
    ControllerRevision
    OK
    201
    ControllerRevision
    Created
    +

    Delete

    +

    delete a ControllerRevision

    +

    HTTP Request

    +DELETE /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ControllerRevision
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of ControllerRevision

    +

    HTTP Request

    +DELETE /apis/apps/v1/namespaces/{namespace}/controllerrevisions +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified ControllerRevision

    +

    HTTP Request

    +GET /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ControllerRevision
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    ControllerRevision
    OK
    +

    List

    +

    list or watch objects of kind ControllerRevision

    +

    HTTP Request

    +GET /apis/apps/v1/namespaces/{namespace}/controllerrevisions +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    ControllerRevisionList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind ControllerRevision

    +

    HTTP Request

    +GET /apis/apps/v1/controllerrevisions +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    ControllerRevisionList
    OK
    +

    Watch

    +

    watch changes to an object of kind ControllerRevision. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/apps/v1/watch/namespaces/{namespace}/controllerrevisions/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ControllerRevision
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of ControllerRevision. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/apps/v1/watch/namespaces/{namespace}/controllerrevisions +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of ControllerRevision. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/apps/v1/watch/controllerrevisions +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    CustomResourceDefinition v1 apiextensions.k8s.io

    + + + + + +
    GroupVersionKind
    apiextensions.k8s.iov1CustomResourceDefinition
    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    spec
    CustomResourceDefinitionSpec
    spec describes how the user wants the resources to appear
    status
    CustomResourceDefinitionStatus
    status indicates the actual state of the CustomResourceDefinition
    +

    CustomResourceDefinitionSpec v1 apiextensions

    + + + + + + + + + + + +
    FieldDescription
    conversion
    CustomResourceConversion
    conversion defines conversion settings for the CRD.
    group
    string
    group is the API group of the defined custom resource. The custom resources are served under `/apis/<group>/...`. Must match the name of the CustomResourceDefinition (in the form `<names.plural>.<group>`).
    names
    CustomResourceDefinitionNames
    names specify the resource and kind names for the custom resource.
    preserveUnknownFields
    boolean
    preserveUnknownFields indicates that object fields which are not specified in the OpenAPI schema should be preserved when persisting to storage. apiVersion, kind, metadata and known fields inside metadata are always preserved. This field is deprecated in favor of setting `x-preserve-unknown-fields` to true in `spec.versions[*].schema.openAPIV3Schema`. See https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#pruning-versus-preserving-unknown-fields for details.
    scope
    string
    scope indicates whether the defined custom resource is cluster- or namespace-scoped. Allowed values are `Cluster` and `Namespaced`.
    versions
    CustomResourceDefinitionVersion array
    versions is the list of all API versions of the defined custom resource. Version names are used to compute the order in which served versions are listed in API discovery. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10.
    +

    CustomResourceDefinitionStatus v1 apiextensions

    + + + + + + + + +
    FieldDescription
    acceptedNames
    CustomResourceDefinitionNames
    acceptedNames are the names that are actually being used to serve discovery. They may be different than the names in spec.
    conditions
    CustomResourceDefinitionCondition array
    conditions indicate state for particular aspects of a CustomResourceDefinition
    storedVersions
    string array
    storedVersions lists all versions of CustomResources that were ever persisted. Tracking these versions allows a migration path for stored versions in etcd. The field is mutable so a migration controller can finish a migration to another version (ensuring no old objects are left in storage), and then remove the rest of the versions from this list. Versions may not be removed from `spec.versions` while they exist in this list.
    +

    CustomResourceDefinitionList v1 apiextensions

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    CustomResourceDefinition array
    items list individual CustomResourceDefinition objects
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    +

    Write Operations

    +

    Create

    +

    create a CustomResourceDefinition

    +

    HTTP Request

    +POST /apis/apiextensions.k8s.io/v1/customresourcedefinitions +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    CustomResourceDefinition
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    CustomResourceDefinition
    OK
    201
    CustomResourceDefinition
    Created
    202
    CustomResourceDefinition
    Accepted
    +

    Patch

    +

    partially update the specified CustomResourceDefinition

    +

    HTTP Request

    +PATCH /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CustomResourceDefinition
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    CustomResourceDefinition
    OK
    +

    Replace

    +

    replace the specified CustomResourceDefinition

    +

    HTTP Request

    +PUT /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CustomResourceDefinition
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    CustomResourceDefinition
    +

    Response

    + + + + + + +
    CodeDescription
    200
    CustomResourceDefinition
    OK
    201
    CustomResourceDefinition
    Created
    +

    Delete

    +

    delete a CustomResourceDefinition

    +

    HTTP Request

    +DELETE /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CustomResourceDefinition
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of CustomResourceDefinition

    +

    HTTP Request

    +DELETE /apis/apiextensions.k8s.io/v1/customresourcedefinitions +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified CustomResourceDefinition

    +

    HTTP Request

    +GET /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CustomResourceDefinition
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    CustomResourceDefinition
    OK
    +

    List

    +

    list or watch objects of kind CustomResourceDefinition

    +

    HTTP Request

    +GET /apis/apiextensions.k8s.io/v1/customresourcedefinitions +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    CustomResourceDefinitionList
    OK
    +

    Watch

    +

    watch changes to an object of kind CustomResourceDefinition. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/apiextensions.k8s.io/v1/watch/customresourcedefinitions/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CustomResourceDefinition
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of CustomResourceDefinition. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/apiextensions.k8s.io/v1/watch/customresourcedefinitions +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Status Operations

    +

    Patch Status

    +

    partially update status of the specified CustomResourceDefinition

    +

    HTTP Request

    +PATCH /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CustomResourceDefinition
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    CustomResourceDefinition
    OK
    +

    Read Status

    +

    read status of the specified CustomResourceDefinition

    +

    HTTP Request

    +GET /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CustomResourceDefinition
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    CustomResourceDefinition
    OK
    +

    Replace Status

    +

    replace status of the specified CustomResourceDefinition

    +

    HTTP Request

    +PUT /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CustomResourceDefinition
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    CustomResourceDefinition
    +

    Response

    + + + + + + +
    CodeDescription
    200
    CustomResourceDefinition
    OK
    201
    CustomResourceDefinition
    Created
    +

    Event v1 core

    + + + + + +
    GroupVersionKind
    corev1Event
    +
    Other API versions of this object exist: +v1beta1 +
    +
    Appears In: + +
    + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    action
    string
    What action was taken/failed regarding to the Regarding object.
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    count
    integer
    The number of times this event has occurred.
    eventTime
    MicroTime
    Time when this Event was first observed.
    firstTimestamp
    Time
    The time at which the event was first recorded. (Time of server receipt is in TypeMeta.)
    involvedObject
    ObjectReference
    The object that this event is about.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    lastTimestamp
    Time
    The time at which the most recent occurrence of this event was recorded.
    message
    string
    A human-readable description of the status of this operation.
    metadata
    ObjectMeta
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    reason
    string
    This should be a short, machine understandable string that gives the reason for the transition into the object's current status.
    related
    ObjectReference
    Optional secondary object for more complex actions.
    reportingComponent
    string
    Name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`.
    reportingInstance
    string
    ID of the controller instance, e.g. `kubelet-xyzf`.
    series
    EventSeries
    Data about the Event series this event represents or nil if it's a singleton Event.
    source
    EventSource
    The component reporting this event. Should be a short machine understandable string.
    type
    string
    Type of this event (Normal, Warning), new types could be added in the future
    +

    EventList v1 core

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    Event array
    List of events
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    +

    Write Operations

    +

    Create

    +

    create an Event

    +

    HTTP Request

    +POST /api/v1/namespaces/{namespace}/events +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Event
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    Event
    OK
    201
    Event
    Created
    202
    Event
    Accepted
    +

    Patch

    +

    partially update the specified Event

    +

    HTTP Request

    +PATCH /api/v1/namespaces/{namespace}/events/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Event
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    Event
    OK
    +

    Replace

    +

    replace the specified Event

    +

    HTTP Request

    +PUT /api/v1/namespaces/{namespace}/events/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Event
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Event
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Event
    OK
    201
    Event
    Created
    +

    Delete

    +

    delete an Event

    +

    HTTP Request

    +DELETE /api/v1/namespaces/{namespace}/events/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Event
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of Event

    +

    HTTP Request

    +DELETE /api/v1/namespaces/{namespace}/events +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified Event

    +

    HTTP Request

    +GET /api/v1/namespaces/{namespace}/events/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Event
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    Event
    OK
    +

    List

    +

    list or watch objects of kind Event

    +

    HTTP Request

    +GET /api/v1/namespaces/{namespace}/events +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    EventList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind Event

    +

    HTTP Request

    +GET /api/v1/events +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    EventList
    OK
    +

    Watch

    +

    watch changes to an object of kind Event. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /api/v1/watch/namespaces/{namespace}/events/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Event
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /api/v1/watch/namespaces/{namespace}/events +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /api/v1/watch/events +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    LimitRange v1 core

    + + + + + +
    GroupVersionKind
    corev1LimitRange
    +
    Appears In: + +
    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    spec
    LimitRangeSpec
    Spec defines the limits enforced. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    +

    LimitRangeSpec v1 core

    +
    Appears In: + +
    + + + + + +
    FieldDescription
    limits
    LimitRangeItem array
    Limits is the list of LimitRangeItem objects that are enforced.
    +

    LimitRangeList v1 core

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    LimitRange array
    Items is a list of LimitRange objects. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    +

    Write Operations

    +

    Create

    +

    create a LimitRange

    +

    HTTP Request

    +POST /api/v1/namespaces/{namespace}/limitranges +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    LimitRange
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    LimitRange
    OK
    201
    LimitRange
    Created
    202
    LimitRange
    Accepted
    +

    Patch

    +

    partially update the specified LimitRange

    +

    HTTP Request

    +PATCH /api/v1/namespaces/{namespace}/limitranges/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the LimitRange
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    LimitRange
    OK
    +

    Replace

    +

    replace the specified LimitRange

    +

    HTTP Request

    +PUT /api/v1/namespaces/{namespace}/limitranges/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the LimitRange
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    LimitRange
    +

    Response

    + + + + + + +
    CodeDescription
    200
    LimitRange
    OK
    201
    LimitRange
    Created
    +

    Delete

    +

    delete a LimitRange

    +

    HTTP Request

    +DELETE /api/v1/namespaces/{namespace}/limitranges/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the LimitRange
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of LimitRange

    +

    HTTP Request

    +DELETE /api/v1/namespaces/{namespace}/limitranges +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified LimitRange

    +

    HTTP Request

    +GET /api/v1/namespaces/{namespace}/limitranges/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the LimitRange
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    LimitRange
    OK
    +

    List

    +

    list or watch objects of kind LimitRange

    +

    HTTP Request

    +GET /api/v1/namespaces/{namespace}/limitranges +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    LimitRangeList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind LimitRange

    +

    HTTP Request

    +GET /api/v1/limitranges +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    LimitRangeList
    OK
    +

    Watch

    +

    watch changes to an object of kind LimitRange. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /api/v1/watch/namespaces/{namespace}/limitranges/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the LimitRange
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of LimitRange. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /api/v1/watch/namespaces/{namespace}/limitranges +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of LimitRange. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /api/v1/watch/limitranges +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    HorizontalPodAutoscaler v1 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv1HorizontalPodAutoscaler
    +
    Other API versions of this object exist: +v2beta2 +v2beta1 +
    + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    spec
    HorizontalPodAutoscalerSpec
    behaviour of autoscaler. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status.
    status
    HorizontalPodAutoscalerStatus
    current information about the autoscaler.
    +

    HorizontalPodAutoscalerSpec v1 autoscaling

    + + + + + + + + + +
    FieldDescription
    maxReplicas
    integer
    upper limit for the number of pods that can be set by the autoscaler; cannot be smaller than MinReplicas.
    minReplicas
    integer
    minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod. minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured. Scaling is active as long as at least one metric value is available.
    scaleTargetRef
    CrossVersionObjectReference
    reference to scaled resource; horizontal pod autoscaler will learn the current resource consumption and will set the desired number of pods by using its Scale subresource.
    targetCPUUtilizationPercentage
    integer
    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.
    +

    HorizontalPodAutoscalerStatus v1 autoscaling

    + + + + + + + + + + +
    FieldDescription
    currentCPUUtilizationPercentage
    integer
    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.
    currentReplicas
    integer
    current number of replicas of pods managed by this autoscaler.
    desiredReplicas
    integer
    desired number of replicas of pods managed by this autoscaler.
    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.
    observedGeneration
    integer
    most recent generation observed by this autoscaler.
    +

    HorizontalPodAutoscalerList v1 autoscaling

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    HorizontalPodAutoscaler array
    list of horizontal pod autoscaler objects.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata.
    +

    Write Operations

    +

    Create

    +

    create a HorizontalPodAutoscaler

    +

    HTTP Request

    +POST /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    HorizontalPodAutoscaler
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    HorizontalPodAutoscaler
    OK
    201
    HorizontalPodAutoscaler
    Created
    202
    HorizontalPodAutoscaler
    Accepted
    +

    Patch

    +

    partially update the specified HorizontalPodAutoscaler

    +

    HTTP Request

    +PATCH /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the HorizontalPodAutoscaler
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    HorizontalPodAutoscaler
    OK
    +

    Replace

    +

    replace the specified HorizontalPodAutoscaler

    +

    HTTP Request

    +PUT /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the HorizontalPodAutoscaler
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    HorizontalPodAutoscaler
    +

    Response

    + + + + + + +
    CodeDescription
    200
    HorizontalPodAutoscaler
    OK
    201
    HorizontalPodAutoscaler
    Created
    +

    Delete

    +

    delete a HorizontalPodAutoscaler

    +

    HTTP Request

    +DELETE /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the HorizontalPodAutoscaler
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of HorizontalPodAutoscaler

    +

    HTTP Request

    +DELETE /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified HorizontalPodAutoscaler

    +

    HTTP Request

    +GET /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the HorizontalPodAutoscaler
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    HorizontalPodAutoscaler
    OK
    +

    List

    +

    list or watch objects of kind HorizontalPodAutoscaler

    +

    HTTP Request

    +GET /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    HorizontalPodAutoscalerList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind HorizontalPodAutoscaler

    +

    HTTP Request

    +GET /apis/autoscaling/v1/horizontalpodautoscalers +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    HorizontalPodAutoscalerList
    OK
    +

    Watch

    +

    watch changes to an object of kind HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/autoscaling/v1/watch/namespaces/{namespace}/horizontalpodautoscalers/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the HorizontalPodAutoscaler
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/autoscaling/v1/watch/namespaces/{namespace}/horizontalpodautoscalers +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/autoscaling/v1/watch/horizontalpodautoscalers +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Status Operations

    +

    Patch Status

    +

    partially update status of the specified HorizontalPodAutoscaler

    +

    HTTP Request

    +PATCH /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the HorizontalPodAutoscaler
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    HorizontalPodAutoscaler
    OK
    +

    Read Status

    +

    read status of the specified HorizontalPodAutoscaler

    +

    HTTP Request

    +GET /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the HorizontalPodAutoscaler
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    HorizontalPodAutoscaler
    OK
    +

    Replace Status

    +

    replace status of the specified HorizontalPodAutoscaler

    +

    HTTP Request

    +PUT /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the HorizontalPodAutoscaler
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    HorizontalPodAutoscaler
    +

    Response

    + + + + + + +
    CodeDescription
    200
    HorizontalPodAutoscaler
    OK
    201
    HorizontalPodAutoscaler
    Created
    +

    MutatingWebhookConfiguration v1 admissionregistration.k8s.io

    + + + + + +
    GroupVersionKind
    admissionregistration.k8s.iov1MutatingWebhookConfiguration
    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
    webhooks
    MutatingWebhook array
    patch strategy: merge
    patch merge key: name
    Webhooks is a list of webhooks and the affected resources and operations.
    +

    MutatingWebhookConfigurationList v1 admissionregistration

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    MutatingWebhookConfiguration array
    List of MutatingWebhookConfiguration.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    +

    Write Operations

    +

    Create

    +

    create a MutatingWebhookConfiguration

    +

    HTTP Request

    +POST /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    MutatingWebhookConfiguration
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    MutatingWebhookConfiguration
    OK
    201
    MutatingWebhookConfiguration
    Created
    202
    MutatingWebhookConfiguration
    Accepted
    +

    Patch

    +

    partially update the specified MutatingWebhookConfiguration

    +

    HTTP Request

    +PATCH /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the MutatingWebhookConfiguration
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    MutatingWebhookConfiguration
    OK
    +

    Replace

    +

    replace the specified MutatingWebhookConfiguration

    +

    HTTP Request

    +PUT /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the MutatingWebhookConfiguration
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    MutatingWebhookConfiguration
    +

    Response

    + + + + + + +
    CodeDescription
    200
    MutatingWebhookConfiguration
    OK
    201
    MutatingWebhookConfiguration
    Created
    +

    Delete

    +

    delete a MutatingWebhookConfiguration

    +

    HTTP Request

    +DELETE /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the MutatingWebhookConfiguration
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of MutatingWebhookConfiguration

    +

    HTTP Request

    +DELETE /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified MutatingWebhookConfiguration

    +

    HTTP Request

    +GET /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the MutatingWebhookConfiguration
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    MutatingWebhookConfiguration
    OK
    +

    List

    +

    list or watch objects of kind MutatingWebhookConfiguration

    +

    HTTP Request

    +GET /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    MutatingWebhookConfigurationList
    OK
    +

    Watch

    +

    watch changes to an object of kind MutatingWebhookConfiguration. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/admissionregistration.k8s.io/v1/watch/mutatingwebhookconfigurations/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the MutatingWebhookConfiguration
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of MutatingWebhookConfiguration. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/admissionregistration.k8s.io/v1/watch/mutatingwebhookconfigurations +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    ValidatingWebhookConfiguration v1 admissionregistration.k8s.io

    + + + + + +
    GroupVersionKind
    admissionregistration.k8s.iov1ValidatingWebhookConfiguration
    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
    webhooks
    ValidatingWebhook array
    patch strategy: merge
    patch merge key: name
    Webhooks is a list of webhooks and the affected resources and operations.
    +

    ValidatingWebhookConfigurationList v1 admissionregistration

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    ValidatingWebhookConfiguration array
    List of ValidatingWebhookConfiguration.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    +

    Write Operations

    +

    Create

    +

    create a ValidatingWebhookConfiguration

    +

    HTTP Request

    +POST /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    ValidatingWebhookConfiguration
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    ValidatingWebhookConfiguration
    OK
    201
    ValidatingWebhookConfiguration
    Created
    202
    ValidatingWebhookConfiguration
    Accepted
    +

    Patch

    +

    partially update the specified ValidatingWebhookConfiguration

    +

    HTTP Request

    +PATCH /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the ValidatingWebhookConfiguration
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    ValidatingWebhookConfiguration
    OK
    +

    Replace

    +

    replace the specified ValidatingWebhookConfiguration

    +

    HTTP Request

    +PUT /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the ValidatingWebhookConfiguration
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    ValidatingWebhookConfiguration
    +

    Response

    + + + + + + +
    CodeDescription
    200
    ValidatingWebhookConfiguration
    OK
    201
    ValidatingWebhookConfiguration
    Created
    +

    Delete

    +

    delete a ValidatingWebhookConfiguration

    +

    HTTP Request

    +DELETE /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the ValidatingWebhookConfiguration
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of ValidatingWebhookConfiguration

    +

    HTTP Request

    +DELETE /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified ValidatingWebhookConfiguration

    +

    HTTP Request

    +GET /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the ValidatingWebhookConfiguration
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    ValidatingWebhookConfiguration
    OK
    +

    List

    +

    list or watch objects of kind ValidatingWebhookConfiguration

    +

    HTTP Request

    +GET /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    ValidatingWebhookConfigurationList
    OK
    +

    Watch

    +

    watch changes to an object of kind ValidatingWebhookConfiguration. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/admissionregistration.k8s.io/v1/watch/validatingwebhookconfigurations/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the ValidatingWebhookConfiguration
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of ValidatingWebhookConfiguration. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/admissionregistration.k8s.io/v1/watch/validatingwebhookconfigurations +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    PodTemplate v1 core

    + + + + + +
    GroupVersionKind
    corev1PodTemplate
    +
    Appears In: + +
    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    template
    PodTemplateSpec
    Template defines the pods that will be created from this pod template. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    +

    PodTemplateSpec v1 core

    + + + + + + + +
    FieldDescription
    metadata
    ObjectMeta
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    spec
    PodSpec
    Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    +

    PodTemplateList v1 core

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    PodTemplate array
    List of pod templates
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    +

    Write Operations

    +

    Create

    +

    create a PodTemplate

    +

    HTTP Request

    +POST /api/v1/namespaces/{namespace}/podtemplates +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    PodTemplate
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    PodTemplate
    OK
    201
    PodTemplate
    Created
    202
    PodTemplate
    Accepted
    +

    Patch

    +

    partially update the specified PodTemplate

    +

    HTTP Request

    +PATCH /api/v1/namespaces/{namespace}/podtemplates/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the PodTemplate
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    PodTemplate
    OK
    +

    Replace

    +

    replace the specified PodTemplate

    +

    HTTP Request

    +PUT /api/v1/namespaces/{namespace}/podtemplates/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the PodTemplate
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    PodTemplate
    +

    Response

    + + + + + + +
    CodeDescription
    200
    PodTemplate
    OK
    201
    PodTemplate
    Created
    +

    Delete

    +

    delete a PodTemplate

    +

    HTTP Request

    +DELETE /api/v1/namespaces/{namespace}/podtemplates/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the PodTemplate
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    PodTemplate
    OK
    202
    PodTemplate
    Accepted
    +

    Delete Collection

    +

    delete collection of PodTemplate

    +

    HTTP Request

    +DELETE /api/v1/namespaces/{namespace}/podtemplates +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified PodTemplate

    +

    HTTP Request

    +GET /api/v1/namespaces/{namespace}/podtemplates/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the PodTemplate
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    PodTemplate
    OK
    +

    List

    +

    list or watch objects of kind PodTemplate

    +

    HTTP Request

    +GET /api/v1/namespaces/{namespace}/podtemplates +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    PodTemplateList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind PodTemplate

    +

    HTTP Request

    +GET /api/v1/podtemplates +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    PodTemplateList
    OK
    +

    Watch

    +

    watch changes to an object of kind PodTemplate. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /api/v1/watch/namespaces/{namespace}/podtemplates/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the PodTemplate
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of PodTemplate. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /api/v1/watch/namespaces/{namespace}/podtemplates +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of PodTemplate. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /api/v1/watch/podtemplates +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    PodDisruptionBudget v1beta1 policy

    + + + + + +
    GroupVersionKind
    policyv1beta1PodDisruptionBudget
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    spec
    PodDisruptionBudgetSpec
    Specification of the desired behavior of the PodDisruptionBudget.
    status
    PodDisruptionBudgetStatus
    Most recently observed status of the PodDisruptionBudget.
    +

    PodDisruptionBudgetSpec v1beta1 policy

    + + + + + + + + +
    FieldDescription
    maxUnavailableAn eviction is allowed if at most "maxUnavailable" pods selected by "selector" are unavailable after the eviction, i.e. even in absence of the evicted pod. For example, one can prevent all voluntary evictions by specifying 0. This is a mutually exclusive setting with "minAvailable".
    minAvailableAn eviction is allowed if at least "minAvailable" pods selected by "selector" will still be available after the eviction, i.e. even in the absence of the evicted pod. So for example you can prevent all voluntary evictions by specifying "100%".
    selector
    LabelSelector
    patch strategy: replace
    Label query over pods whose evictions are managed by the disruption budget. A null selector selects no pods. An empty selector ({}) also selects no pods, which differs from standard behavior of selecting all pods. In policy/v1, an empty selector will select all pods in the namespace.
    +

    PodDisruptionBudgetStatus v1beta1 policy

    + + + + + + + + + + + + +
    FieldDescription
    conditions
    Condition array
    patch strategy: merge
    patch merge key: type
    Conditions contain conditions for PDB. The disruption controller sets the DisruptionAllowed condition. The following are known values for the reason field (additional reasons could be added in the future): - SyncFailed: The controller encountered an error and wasn't able to compute the number of allowed disruptions. Therefore no disruptions are allowed and the status of the condition will be False. - InsufficientPods: The number of pods are either at or below the number required by the PodDisruptionBudget. No disruptions are allowed and the status of the condition will be False. - SufficientPods: There are more pods than required by the PodDisruptionBudget. The condition will be True, and the number of allowed disruptions are provided by the disruptionsAllowed property.
    currentHealthy
    integer
    current number of healthy pods
    desiredHealthy
    integer
    minimum desired number of healthy pods
    disruptedPods
    object
    DisruptedPods contains information about pods whose eviction was processed by the API server eviction subresource handler but has not yet been observed by the PodDisruptionBudget controller. A pod will be in this map from the time when the API server processed the eviction request to the time when the pod is seen by PDB controller as having been marked for deletion (or after a timeout). The key in the map is the name of the pod and the value is the time when the API server processed the eviction request. If the deletion didn't occur and a pod is still there it will be removed from the list automatically by PodDisruptionBudget controller after some time. If everything goes smooth this map should be empty for the most of the time. Large number of entries in the map may indicate problems with pod deletions.
    disruptionsAllowed
    integer
    Number of pod disruptions that are currently allowed.
    expectedPods
    integer
    total number of pods counted by this disruption budget
    observedGeneration
    integer
    Most recent generation observed when updating this PDB status. DisruptionsAllowed and other status information is valid only if observedGeneration equals to PDB's object generation.
    +

    PodDisruptionBudgetList v1beta1 policy

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    PodDisruptionBudget array
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    +

    Write Operations

    +

    Create

    +

    create a PodDisruptionBudget

    +

    HTTP Request

    +POST /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    PodDisruptionBudget
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    PodDisruptionBudget
    OK
    201
    PodDisruptionBudget
    Created
    202
    PodDisruptionBudget
    Accepted
    +

    Patch

    +

    partially update the specified PodDisruptionBudget

    +

    HTTP Request

    +PATCH /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the PodDisruptionBudget
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    PodDisruptionBudget
    OK
    +

    Replace

    +

    replace the specified PodDisruptionBudget

    +

    HTTP Request

    +PUT /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the PodDisruptionBudget
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    PodDisruptionBudget
    +

    Response

    + + + + + + +
    CodeDescription
    200
    PodDisruptionBudget
    OK
    201
    PodDisruptionBudget
    Created
    +

    Delete

    +

    delete a PodDisruptionBudget

    +

    HTTP Request

    +DELETE /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the PodDisruptionBudget
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of PodDisruptionBudget

    +

    HTTP Request

    +DELETE /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified PodDisruptionBudget

    +

    HTTP Request

    +GET /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the PodDisruptionBudget
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    PodDisruptionBudget
    OK
    +

    List

    +

    list or watch objects of kind PodDisruptionBudget

    +

    HTTP Request

    +GET /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    PodDisruptionBudgetList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind PodDisruptionBudget

    +

    HTTP Request

    +GET /apis/policy/v1beta1/poddisruptionbudgets +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    PodDisruptionBudgetList
    OK
    +

    Watch

    +

    watch changes to an object of kind PodDisruptionBudget. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/policy/v1beta1/watch/namespaces/{namespace}/poddisruptionbudgets/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the PodDisruptionBudget
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of PodDisruptionBudget. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/policy/v1beta1/watch/namespaces/{namespace}/poddisruptionbudgets +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of PodDisruptionBudget. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/policy/v1beta1/watch/poddisruptionbudgets +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Status Operations

    +

    Patch Status

    +

    partially update status of the specified PodDisruptionBudget

    +

    HTTP Request

    +PATCH /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the PodDisruptionBudget
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    PodDisruptionBudget
    OK
    +

    Read Status

    +

    read status of the specified PodDisruptionBudget

    +

    HTTP Request

    +GET /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the PodDisruptionBudget
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    PodDisruptionBudget
    OK
    +

    Replace Status

    +

    replace status of the specified PodDisruptionBudget

    +

    HTTP Request

    +PUT /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the PodDisruptionBudget
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    PodDisruptionBudget
    +

    Response

    + + + + + + +
    CodeDescription
    200
    PodDisruptionBudget
    OK
    201
    PodDisruptionBudget
    Created
    +

    PriorityClass v1 scheduling.k8s.io

    + + + + + +
    GroupVersionKind
    scheduling.k8s.iov1PriorityClass
    +
    Other API versions of this object exist: +v1beta1 +v1alpha1 +
    + + + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    description
    string
    description is an arbitrary string that usually provides guidelines on when this priority class should be used.
    globalDefault
    boolean
    globalDefault specifies whether this PriorityClass should be considered as the default priority for pods that do not have any priority class. Only one PriorityClass can be marked as `globalDefault`. However, if more than one PriorityClasses exists with their `globalDefault` field set to true, the smallest value of such global default PriorityClasses will be used as the default priority.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    preemptionPolicy
    string
    PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate.
    value
    integer
    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.
    +

    PriorityClassList v1 scheduling

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    PriorityClass array
    items is the list of PriorityClasses
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    +

    Write Operations

    +

    Create

    +

    create a PriorityClass

    +

    HTTP Request

    +POST /apis/scheduling.k8s.io/v1/priorityclasses +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    PriorityClass
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    PriorityClass
    OK
    201
    PriorityClass
    Created
    202
    PriorityClass
    Accepted
    +

    Patch

    +

    partially update the specified PriorityClass

    +

    HTTP Request

    +PATCH /apis/scheduling.k8s.io/v1/priorityclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the PriorityClass
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    PriorityClass
    OK
    +

    Replace

    +

    replace the specified PriorityClass

    +

    HTTP Request

    +PUT /apis/scheduling.k8s.io/v1/priorityclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the PriorityClass
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    PriorityClass
    +

    Response

    + + + + + + +
    CodeDescription
    200
    PriorityClass
    OK
    201
    PriorityClass
    Created
    +

    Delete

    +

    delete a PriorityClass

    +

    HTTP Request

    +DELETE /apis/scheduling.k8s.io/v1/priorityclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the PriorityClass
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of PriorityClass

    +

    HTTP Request

    +DELETE /apis/scheduling.k8s.io/v1/priorityclasses +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified PriorityClass

    +

    HTTP Request

    +GET /apis/scheduling.k8s.io/v1/priorityclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the PriorityClass
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    PriorityClass
    OK
    +

    List

    +

    list or watch objects of kind PriorityClass

    +

    HTTP Request

    +GET /apis/scheduling.k8s.io/v1/priorityclasses +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    PriorityClassList
    OK
    +

    Watch

    +

    watch changes to an object of kind PriorityClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/scheduling.k8s.io/v1/watch/priorityclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the PriorityClass
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of PriorityClass. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/scheduling.k8s.io/v1/watch/priorityclasses +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    PodSecurityPolicy v1beta1 policy

    + + + + + +
    GroupVersionKind
    policyv1beta1PodSecurityPolicy
    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    spec
    PodSecurityPolicySpec
    spec defines the policy enforced.
    +

    PodSecurityPolicySpec v1beta1 policy

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    allowPrivilegeEscalation
    boolean
    allowPrivilegeEscalation determines if a pod can request to allow privilege escalation. If unspecified, defaults to true.
    allowedCSIDrivers
    AllowedCSIDriver array
    AllowedCSIDrivers is an allowlist of inline CSI drivers that must be explicitly set to be embedded within a pod spec. An empty value indicates that any CSI driver can be used for inline ephemeral volumes. This is a beta field, and is only honored if the API server enables the CSIInlineVolume feature gate.
    allowedCapabilities
    string array
    allowedCapabilities is a list of capabilities that can be requested to add to the container. Capabilities in this field may be added at the pod author's discretion. You must not list a capability in both allowedCapabilities and requiredDropCapabilities.
    allowedFlexVolumes
    AllowedFlexVolume array
    allowedFlexVolumes is an allowlist of Flexvolumes. Empty or nil indicates that all Flexvolumes may be used. This parameter is effective only when the usage of the Flexvolumes is allowed in the "volumes" field.
    allowedHostPaths
    AllowedHostPath array
    allowedHostPaths is an allowlist of host paths. Empty indicates that all host paths may be used.
    allowedProcMountTypes
    string array
    AllowedProcMountTypes is an allowlist of allowed ProcMountTypes. Empty or nil indicates that only the DefaultProcMountType may be used. This requires the ProcMountType feature flag to be enabled.
    allowedUnsafeSysctls
    string array
    allowedUnsafeSysctls is a list of explicitly allowed unsafe sysctls, defaults to none. Each entry is either a plain sysctl name or ends in "*" in which case it is considered as a prefix of allowed sysctls. Single * means all unsafe sysctls are allowed. Kubelet has to allowlist all allowed unsafe sysctls explicitly to avoid rejection. Examples: e.g. "foo/*" allows "foo/bar", "foo/baz", etc. e.g. "foo.*" allows "foo.bar", "foo.baz", etc.
    defaultAddCapabilities
    string array
    defaultAddCapabilities is the default set of capabilities that will be added to the container unless the pod spec specifically drops the capability. You may not list a capability in both defaultAddCapabilities and requiredDropCapabilities. Capabilities added here are implicitly allowed, and need not be included in the allowedCapabilities list.
    defaultAllowPrivilegeEscalation
    boolean
    defaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process.
    forbiddenSysctls
    string array
    forbiddenSysctls is a list of explicitly forbidden sysctls, defaults to none. Each entry is either a plain sysctl name or ends in "*" in which case it is considered as a prefix of forbidden sysctls. Single * means all sysctls are forbidden. Examples: e.g. "foo/*" forbids "foo/bar", "foo/baz", etc. e.g. "foo.*" forbids "foo.bar", "foo.baz", etc.
    fsGroup
    FSGroupStrategyOptions
    fsGroup is the strategy that will dictate what fs group is used by the SecurityContext.
    hostIPC
    boolean
    hostIPC determines if the policy allows the use of HostIPC in the pod spec.
    hostNetwork
    boolean
    hostNetwork determines if the policy allows the use of HostNetwork in the pod spec.
    hostPID
    boolean
    hostPID determines if the policy allows the use of HostPID in the pod spec.
    hostPorts
    HostPortRange array
    hostPorts determines which host port ranges are allowed to be exposed.
    privileged
    boolean
    privileged determines if a pod can request to be run as privileged.
    readOnlyRootFilesystem
    boolean
    readOnlyRootFilesystem when set to true will force containers to run with a read only root file system. If the container specifically requests to run with a non-read only root file system the PSP should deny the pod. If set to false the container may run with a read only root file system if it wishes but it will not be forced to.
    requiredDropCapabilities
    string array
    requiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added.
    runAsGroup
    RunAsGroupStrategyOptions
    RunAsGroup is the strategy that will dictate the allowable RunAsGroup values that may be set. If this field is omitted, the pod's RunAsGroup can take any value. This field requires the RunAsGroup feature gate to be enabled.
    runAsUser
    RunAsUserStrategyOptions
    runAsUser is the strategy that will dictate the allowable RunAsUser values that may be set.
    runtimeClass
    RuntimeClassStrategyOptions
    runtimeClass is the strategy that will dictate the allowable RuntimeClasses for a pod. If this field is omitted, the pod's runtimeClassName field is unrestricted. Enforcement of this field depends on the RuntimeClass feature gate being enabled.
    seLinux
    SELinuxStrategyOptions
    seLinux is the strategy that will dictate the allowable labels that may be set.
    supplementalGroups
    SupplementalGroupsStrategyOptions
    supplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext.
    volumes
    string array
    volumes is an allowlist of volume plugins. Empty indicates that no volumes may be used. To allow all volumes you may use '\*'.
    +

    PodSecurityPolicyList v1beta1 policy

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    PodSecurityPolicy array
    items is a list of schema objects.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    +

    Write Operations

    +

    Create

    +

    create a PodSecurityPolicy

    +

    HTTP Request

    +POST /apis/policy/v1beta1/podsecuritypolicies +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    PodSecurityPolicy
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    PodSecurityPolicy
    OK
    201
    PodSecurityPolicy
    Created
    202
    PodSecurityPolicy
    Accepted
    +

    Patch

    +

    partially update the specified PodSecurityPolicy

    +

    HTTP Request

    +PATCH /apis/policy/v1beta1/podsecuritypolicies/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the PodSecurityPolicy
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    PodSecurityPolicy
    OK
    +

    Replace

    +

    replace the specified PodSecurityPolicy

    +

    HTTP Request

    +PUT /apis/policy/v1beta1/podsecuritypolicies/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the PodSecurityPolicy
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    PodSecurityPolicy
    +

    Response

    + + + + + + +
    CodeDescription
    200
    PodSecurityPolicy
    OK
    201
    PodSecurityPolicy
    Created
    +

    Delete

    +

    delete a PodSecurityPolicy

    +

    HTTP Request

    +DELETE /apis/policy/v1beta1/podsecuritypolicies/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the PodSecurityPolicy
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    PodSecurityPolicy
    OK
    202
    PodSecurityPolicy
    Accepted
    +

    Delete Collection

    +

    delete collection of PodSecurityPolicy

    +

    HTTP Request

    +DELETE /apis/policy/v1beta1/podsecuritypolicies +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified PodSecurityPolicy

    +

    HTTP Request

    +GET /apis/policy/v1beta1/podsecuritypolicies/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the PodSecurityPolicy
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    PodSecurityPolicy
    OK
    +

    List

    +

    list or watch objects of kind PodSecurityPolicy

    +

    HTTP Request

    +GET /apis/policy/v1beta1/podsecuritypolicies +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    PodSecurityPolicyList
    OK
    +

    Watch

    +

    watch changes to an object of kind PodSecurityPolicy. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/policy/v1beta1/watch/podsecuritypolicies/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the PodSecurityPolicy
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of PodSecurityPolicy. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/policy/v1beta1/watch/podsecuritypolicies +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    CLUSTER

    + +

    Cluster resources are responsible for defining configuration of the cluster itself, and are generally only used by cluster operators.

    + +
    +

    APIService v1 apiregistration.k8s.io

    + + + + + +
    GroupVersionKind
    apiregistration.k8s.iov1APIService
    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    spec
    APIServiceSpec
    Spec contains information for locating and communicating with a server
    status
    APIServiceStatus
    Status contains derived information about an API server
    +

    APIServiceSpec v1 apiregistration

    +
    Appears In: + +
    + + + + + + + + + + + +
    FieldDescription
    caBundle
    string
    CABundle is a PEM encoded CA bundle which will be used to validate an API server's serving certificate. If unspecified, system trust roots on the apiserver are used.
    group
    string
    Group is the API group name this server hosts
    groupPriorityMinimum
    integer
    GroupPriorityMininum is the priority this group should have at least. Higher priority means that the group is preferred by clients over lower priority ones. Note that other versions of this group might specify even higher GroupPriorityMininum values such that the whole group gets a higher priority. The primary sort is based on GroupPriorityMinimum, ordered highest number to lowest (20 before 10). The secondary sort is based on the alphabetical comparison of the name of the object. (v1.bar before v1.foo) We'd recommend something like: *.k8s.io (except extensions) at 18000 and PaaSes (OpenShift, Deis) are recommended to be in the 2000s
    insecureSkipTLSVerify
    boolean
    InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server. This is strongly discouraged. You should use the CABundle instead.
    service
    ServiceReference
    Service is a reference to the service for this API server. It must communicate on port 443. If the Service is nil, that means the handling for the API groupversion is handled locally on this server. The call will simply delegate to the normal handler chain to be fulfilled.
    version
    string
    Version is the API version this server hosts. For example, "v1"
    versionPriority
    integer
    VersionPriority controls the ordering of this API version inside of its group. Must be greater than zero. The primary sort is based on VersionPriority, ordered highest to lowest (20 before 10). Since it's inside of a group, the number can be small, probably in the 10s. In case of equal version priorities, the version string will be used to compute the order inside a group. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10.
    +

    APIServiceStatus v1 apiregistration

    +
    Appears In: + +
    + + + + + +
    FieldDescription
    conditions
    APIServiceCondition array
    patch strategy: merge
    patch merge key: type
    Current service state of apiService.
    +

    APIServiceList v1 apiregistration

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    APIService array
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    +

    Write Operations

    +

    Create

    +

    create an APIService

    +

    HTTP Request

    +POST /apis/apiregistration.k8s.io/v1/apiservices +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    APIService
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    APIService
    OK
    201
    APIService
    Created
    202
    APIService
    Accepted
    +

    Patch

    +

    partially update the specified APIService

    +

    HTTP Request

    +PATCH /apis/apiregistration.k8s.io/v1/apiservices/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the APIService
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    APIService
    OK
    +

    Replace

    +

    replace the specified APIService

    +

    HTTP Request

    +PUT /apis/apiregistration.k8s.io/v1/apiservices/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the APIService
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    APIService
    +

    Response

    + + + + + + +
    CodeDescription
    200
    APIService
    OK
    201
    APIService
    Created
    +

    Delete

    +

    delete an APIService

    +

    HTTP Request

    +DELETE /apis/apiregistration.k8s.io/v1/apiservices/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the APIService
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of APIService

    +

    HTTP Request

    +DELETE /apis/apiregistration.k8s.io/v1/apiservices +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified APIService

    +

    HTTP Request

    +GET /apis/apiregistration.k8s.io/v1/apiservices/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the APIService
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    APIService
    OK
    +

    List

    +

    list or watch objects of kind APIService

    +

    HTTP Request

    +GET /apis/apiregistration.k8s.io/v1/apiservices +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    APIServiceList
    OK
    +

    Watch

    +

    watch changes to an object of kind APIService. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/apiregistration.k8s.io/v1/watch/apiservices/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the APIService
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of APIService. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/apiregistration.k8s.io/v1/watch/apiservices +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Status Operations

    +

    Patch Status

    +

    partially update status of the specified APIService

    +

    HTTP Request

    +PATCH /apis/apiregistration.k8s.io/v1/apiservices/{name}/status +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the APIService
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    APIService
    OK
    +

    Read Status

    +

    read status of the specified APIService

    +

    HTTP Request

    +GET /apis/apiregistration.k8s.io/v1/apiservices/{name}/status +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the APIService
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    APIService
    OK
    +

    Replace Status

    +

    replace status of the specified APIService

    +

    HTTP Request

    +PUT /apis/apiregistration.k8s.io/v1/apiservices/{name}/status +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the APIService
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    APIService
    +

    Response

    + + + + + + +
    CodeDescription
    200
    APIService
    OK
    201
    APIService
    Created
    +

    Binding v1 core

    + + + + + +
    GroupVersionKind
    corev1Binding
    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    target
    ObjectReference
    The target object that you want to bind to the standard object.
    +

    Write Operations

    +

    Create

    +

    create a Binding

    +

    HTTP Request

    +POST /api/v1/namespaces/{namespace}/bindings +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    dryRunWhen 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
    fieldManagerfieldManager 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.
    prettyIf 'true', then the output is pretty printed.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Binding
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    Binding
    OK
    201
    Binding
    Created
    202
    Binding
    Accepted
    +

    CertificateSigningRequest v1 certificates.k8s.io

    + + + + + +
    GroupVersionKind
    certificates.k8s.iov1CertificateSigningRequest
    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    spec
    CertificateSigningRequestSpec
    spec contains the certificate request, and is immutable after creation. Only the request, signerName, and usages fields can be set on creation. Other fields are derived by Kubernetes and cannot be modified by users.
    status
    CertificateSigningRequestStatus
    status contains information about whether the request is approved or denied, and the certificate issued by the signer, or the failure condition indicating signer failure.
    +

    CertificateSigningRequestSpec v1 certificates

    + + + + + + + + + + + + +
    FieldDescription
    extra
    object
    extra contains extra attributes of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable.
    groups
    string array
    groups contains group membership of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable.
    request
    string
    request contains an x509 certificate signing request encoded in a "CERTIFICATE REQUEST" PEM block. When serialized as JSON or YAML, the data is additionally base64-encoded.
    signerName
    string
    signerName indicates the requested signer, and is a qualified name. List/watch requests for CertificateSigningRequests can filter on this field using a "spec.signerName=NAME" fieldSelector. Well-known Kubernetes signers are: 1. "kubernetes.io/kube-apiserver-client": issues client certificates that can be used to authenticate to kube-apiserver. Requests for this signer are never auto-approved by kube-controller-manager, can be issued by the "csrsigning" controller in kube-controller-manager. 2. "kubernetes.io/kube-apiserver-client-kubelet": issues client certificates that kubelets use to authenticate to kube-apiserver. Requests for this signer can be auto-approved by the "csrapproving" controller in kube-controller-manager, and can be issued by the "csrsigning" controller in kube-controller-manager. 3. "kubernetes.io/kubelet-serving" issues serving certificates that kubelets use to serve TLS endpoints, which kube-apiserver can connect to securely. Requests for this signer are never auto-approved by kube-controller-manager, and can be issued by the "csrsigning" controller in kube-controller-manager. More details are available at https://k8s.io/docs/reference/access-authn-authz/certificate-signing-requests/#kubernetes-signers Custom signerNames can also be specified. The signer defines: 1. Trust distribution: how trust (CA bundles) are distributed. 2. Permitted subjects: and behavior when a disallowed subject is requested. 3. Required, permitted, or forbidden x509 extensions in the request (including whether subjectAltNames are allowed, which types, restrictions on allowed values) and behavior when a disallowed extension is requested. 4. Required, permitted, or forbidden key usages / extended key usages. 5. Expiration/certificate lifetime: whether it is fixed by the signer, configurable by the admin. 6. Whether or not requests for CA certificates are allowed.
    uid
    string
    uid contains the uid of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable.
    usages
    string array
    usages specifies a set of key usages requested in the issued certificate. Requests for TLS client certificates typically request: "digital signature", "key encipherment", "client auth". Requests for TLS serving certificates typically request: "key encipherment", "digital signature", "server auth". Valid values are: "signing", "digital signature", "content commitment", "key encipherment", "key agreement", "data encipherment", "cert sign", "crl sign", "encipher only", "decipher only", "any", "server auth", "client auth", "code signing", "email protection", "s/mime", "ipsec end system", "ipsec tunnel", "ipsec user", "timestamping", "ocsp signing", "microsoft sgc", "netscape sgc"
    username
    string
    username contains the name of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable.
    +

    CertificateSigningRequestStatus v1 certificates

    + + + + + + + +
    FieldDescription
    certificate
    string
    certificate is populated with an issued certificate by the signer after an Approved condition is present. This field is set via the /status subresource. Once populated, this field is immutable. If the certificate signing request is denied, a condition of type "Denied" is added and this field remains empty. If the signer cannot issue the certificate, a condition of type "Failed" is added and this field remains empty. Validation requirements: 1. certificate must contain one or more PEM blocks. 2. All PEM blocks must have the "CERTIFICATE" label, contain no headers, and the encoded data must be a BER-encoded ASN.1 Certificate structure as described in section 4 of RFC5280. 3. Non-PEM content may appear before or after the "CERTIFICATE" PEM blocks and is unvalidated, to allow for explanatory text as described in section 5.2 of RFC7468. If more than one PEM block is present, and the definition of the requested spec.signerName does not indicate otherwise, the first block is the issued certificate, and subsequent blocks should be treated as intermediate certificates and presented in TLS handshakes. The certificate is encoded in PEM format. When serialized as JSON or YAML, the data is additionally base64-encoded, so it consists of: base64( -----BEGIN CERTIFICATE----- ... -----END CERTIFICATE----- )
    conditions
    CertificateSigningRequestCondition array
    conditions applied to the request. Known conditions are "Approved", "Denied", and "Failed".
    +

    CertificateSigningRequestList v1 certificates

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    CertificateSigningRequest array
    items is a collection of CertificateSigningRequest objects
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    +

    Write Operations

    +

    Create

    +

    create a CertificateSigningRequest

    +

    HTTP Request

    +POST /apis/certificates.k8s.io/v1/certificatesigningrequests +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    CertificateSigningRequest
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    CertificateSigningRequest
    OK
    201
    CertificateSigningRequest
    Created
    202
    CertificateSigningRequest
    Accepted
    +

    Patch

    +

    partially update the specified CertificateSigningRequest

    +

    HTTP Request

    +PATCH /apis/certificates.k8s.io/v1/certificatesigningrequests/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CertificateSigningRequest
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    CertificateSigningRequest
    OK
    +

    Replace

    +

    replace the specified CertificateSigningRequest

    +

    HTTP Request

    +PUT /apis/certificates.k8s.io/v1/certificatesigningrequests/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CertificateSigningRequest
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    CertificateSigningRequest
    +

    Response

    + + + + + + +
    CodeDescription
    200
    CertificateSigningRequest
    OK
    201
    CertificateSigningRequest
    Created
    +

    Delete

    +

    delete a CertificateSigningRequest

    +

    HTTP Request

    +DELETE /apis/certificates.k8s.io/v1/certificatesigningrequests/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CertificateSigningRequest
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of CertificateSigningRequest

    +

    HTTP Request

    +DELETE /apis/certificates.k8s.io/v1/certificatesigningrequests +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified CertificateSigningRequest

    +

    HTTP Request

    +GET /apis/certificates.k8s.io/v1/certificatesigningrequests/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CertificateSigningRequest
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    CertificateSigningRequest
    OK
    +

    List

    +

    list or watch objects of kind CertificateSigningRequest

    +

    HTTP Request

    +GET /apis/certificates.k8s.io/v1/certificatesigningrequests +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    CertificateSigningRequestList
    OK
    +

    Watch

    +

    watch changes to an object of kind CertificateSigningRequest. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/certificates.k8s.io/v1/watch/certificatesigningrequests/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CertificateSigningRequest
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of CertificateSigningRequest. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/certificates.k8s.io/v1/watch/certificatesigningrequests +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Status Operations

    +

    Patch Status

    +

    partially update status of the specified CertificateSigningRequest

    +

    HTTP Request

    +PATCH /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/status +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CertificateSigningRequest
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    CertificateSigningRequest
    OK
    +

    Read Status

    +

    read status of the specified CertificateSigningRequest

    +

    HTTP Request

    +GET /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/status +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CertificateSigningRequest
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    CertificateSigningRequest
    OK
    +

    Replace Status

    +

    replace status of the specified CertificateSigningRequest

    +

    HTTP Request

    +PUT /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/status +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CertificateSigningRequest
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    CertificateSigningRequest
    +

    Response

    + + + + + + +
    CodeDescription
    200
    CertificateSigningRequest
    OK
    201
    CertificateSigningRequest
    Created
    +

    ClusterRole v1 rbac.authorization.k8s.io

    + + + + + +
    GroupVersionKind
    rbac.authorization.k8s.iov1ClusterRole
    +
    Other API versions of this object exist: +v1beta1 +v1alpha1 +
    +
    Appears In: + +
    + + + + + + + + + +
    FieldDescription
    aggregationRule
    AggregationRule
    AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. If AggregationRule is set, then the Rules are controller managed and direct changes to Rules will be stomped by the controller.
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata.
    rules
    PolicyRule array
    Rules holds all the PolicyRules for this ClusterRole
    +

    ClusterRoleList v1 rbac

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    ClusterRole array
    Items is a list of ClusterRoles
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard object's metadata.
    +

    Write Operations

    +

    Create

    +

    create a ClusterRole

    +

    HTTP Request

    +POST /apis/rbac.authorization.k8s.io/v1/clusterroles +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    ClusterRole
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    ClusterRole
    OK
    201
    ClusterRole
    Created
    202
    ClusterRole
    Accepted
    +

    Patch

    +

    partially update the specified ClusterRole

    +

    HTTP Request

    +PATCH /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the ClusterRole
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    ClusterRole
    OK
    +

    Replace

    +

    replace the specified ClusterRole

    +

    HTTP Request

    +PUT /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the ClusterRole
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    ClusterRole
    +

    Response

    + + + + + + +
    CodeDescription
    200
    ClusterRole
    OK
    201
    ClusterRole
    Created
    +

    Delete

    +

    delete a ClusterRole

    +

    HTTP Request

    +DELETE /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the ClusterRole
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of ClusterRole

    +

    HTTP Request

    +DELETE /apis/rbac.authorization.k8s.io/v1/clusterroles +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified ClusterRole

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the ClusterRole
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    ClusterRole
    OK
    +

    List

    +

    list or watch objects of kind ClusterRole

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1/clusterroles +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    ClusterRoleList
    OK
    +

    Watch

    +

    watch changes to an object of kind ClusterRole. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1/watch/clusterroles/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the ClusterRole
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of ClusterRole. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1/watch/clusterroles +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    ClusterRoleBinding v1 rbac.authorization.k8s.io

    + + + + + +
    GroupVersionKind
    rbac.authorization.k8s.iov1ClusterRoleBinding
    +
    Other API versions of this object exist: +v1beta1 +v1alpha1 +
    + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata.
    roleRef
    RoleRef
    RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.
    subjects
    Subject array
    Subjects holds references to the objects the role applies to.
    +

    ClusterRoleBindingList v1 rbac

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    ClusterRoleBinding array
    Items is a list of ClusterRoleBindings
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard object's metadata.
    +

    Write Operations

    +

    Create

    +

    create a ClusterRoleBinding

    +

    HTTP Request

    +POST /apis/rbac.authorization.k8s.io/v1/clusterrolebindings +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    ClusterRoleBinding
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    ClusterRoleBinding
    OK
    201
    ClusterRoleBinding
    Created
    202
    ClusterRoleBinding
    Accepted
    +

    Patch

    +

    partially update the specified ClusterRoleBinding

    +

    HTTP Request

    +PATCH /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the ClusterRoleBinding
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    ClusterRoleBinding
    OK
    +

    Replace

    +

    replace the specified ClusterRoleBinding

    +

    HTTP Request

    +PUT /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the ClusterRoleBinding
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    ClusterRoleBinding
    +

    Response

    + + + + + + +
    CodeDescription
    200
    ClusterRoleBinding
    OK
    201
    ClusterRoleBinding
    Created
    +

    Delete

    +

    delete a ClusterRoleBinding

    +

    HTTP Request

    +DELETE /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the ClusterRoleBinding
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of ClusterRoleBinding

    +

    HTTP Request

    +DELETE /apis/rbac.authorization.k8s.io/v1/clusterrolebindings +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified ClusterRoleBinding

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the ClusterRoleBinding
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    ClusterRoleBinding
    OK
    +

    List

    +

    list or watch objects of kind ClusterRoleBinding

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1/clusterrolebindings +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    ClusterRoleBindingList
    OK
    +

    Watch

    +

    watch changes to an object of kind ClusterRoleBinding. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1/watch/clusterrolebindings/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the ClusterRoleBinding
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of ClusterRoleBinding. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1/watch/clusterrolebindings +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    ComponentStatus v1 core

    + + + + + +
    GroupVersionKind
    corev1ComponentStatus
    +
    Appears In: + +
    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    conditions
    ComponentCondition array
    patch strategy: merge
    patch merge key: type
    List of component conditions observed
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    +

    ComponentStatusList v1 core

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    ComponentStatus array
    List of ComponentStatus objects.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    +

    Read Operations

    +

    Read

    +

    read the specified ComponentStatus

    +

    HTTP Request

    +GET /api/v1/componentstatuses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the ComponentStatus
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    ComponentStatus
    OK
    +

    List

    +

    list objects of kind ComponentStatus

    +

    HTTP Request

    +GET /api/v1/componentstatuses +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    ComponentStatusList
    OK
    +

    FlowSchema v1beta1 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta1FlowSchema
    + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    `metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    spec
    FlowSchemaSpec
    `spec` is the specification of the desired behavior of a FlowSchema. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    status
    FlowSchemaStatus
    `status` is the current status of a FlowSchema. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    +

    FlowSchemaSpec v1beta1 flowcontrol

    + + + + + + + + + +
    FieldDescription
    distinguisherMethod
    FlowDistinguisherMethod
    `distinguisherMethod` defines how to compute the flow distinguisher for requests that match this schema. `nil` specifies that the distinguisher is disabled and thus will always be the empty string.
    matchingPrecedence
    integer
    `matchingPrecedence` is used to choose among the FlowSchemas that match a given request. The chosen FlowSchema is among those with the numerically lowest (which we take to be logically highest) MatchingPrecedence. Each MatchingPrecedence value must be ranged in [1,10000]. Note that if the precedence is not specified, it will be set to 1000 as default.
    priorityLevelConfiguration
    PriorityLevelConfigurationReference
    `priorityLevelConfiguration` should reference a PriorityLevelConfiguration in the cluster. If the reference cannot be resolved, the FlowSchema will be ignored and marked as invalid in its status. Required.
    rules
    PolicyRulesWithSubjects array
    `rules` describes which requests will match this flow schema. This FlowSchema matches a request if and only if at least one member of rules matches the request. if it is an empty slice, there will be no requests matching the FlowSchema.
    +

    FlowSchemaStatus v1beta1 flowcontrol

    + + + + + + +
    FieldDescription
    conditions
    FlowSchemaCondition array
    `conditions` is a list of the current states of FlowSchema.
    +

    FlowSchemaList v1beta1 flowcontrol

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    FlowSchema array
    `items` is a list of FlowSchemas.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    `metadata` is the standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    +

    Write Operations

    +

    Create

    +

    create a FlowSchema

    +

    HTTP Request

    +POST /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    FlowSchema
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    FlowSchema
    OK
    201
    FlowSchema
    Created
    202
    FlowSchema
    Accepted
    +

    Patch

    +

    partially update the specified FlowSchema

    +

    HTTP Request

    +PATCH /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the FlowSchema
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    FlowSchema
    OK
    +

    Replace

    +

    replace the specified FlowSchema

    +

    HTTP Request

    +PUT /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the FlowSchema
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    FlowSchema
    +

    Response

    + + + + + + +
    CodeDescription
    200
    FlowSchema
    OK
    201
    FlowSchema
    Created
    +

    Delete

    +

    delete a FlowSchema

    +

    HTTP Request

    +DELETE /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the FlowSchema
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of FlowSchema

    +

    HTTP Request

    +DELETE /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified FlowSchema

    +

    HTTP Request

    +GET /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the FlowSchema
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    FlowSchema
    OK
    +

    List

    +

    list or watch objects of kind FlowSchema

    +

    HTTP Request

    +GET /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    FlowSchemaList
    OK
    +

    Watch

    +

    watch changes to an object of kind FlowSchema. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/flowcontrol.apiserver.k8s.io/v1beta1/watch/flowschemas/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the FlowSchema
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of FlowSchema. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/flowcontrol.apiserver.k8s.io/v1beta1/watch/flowschemas +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Status Operations

    +

    Patch Status

    +

    partially update status of the specified FlowSchema

    +

    HTTP Request

    +PATCH /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas/{name}/status +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the FlowSchema
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    FlowSchema
    OK
    +

    Read Status

    +

    read status of the specified FlowSchema

    +

    HTTP Request

    +GET /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas/{name}/status +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the FlowSchema
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    FlowSchema
    OK
    +

    Replace Status

    +

    replace status of the specified FlowSchema

    +

    HTTP Request

    +PUT /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas/{name}/status +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the FlowSchema
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    FlowSchema
    +

    Response

    + + + + + + +
    CodeDescription
    200
    FlowSchema
    OK
    201
    FlowSchema
    Created
    +

    Lease v1 coordination.k8s.io

    + + + + + +
    GroupVersionKind
    coordination.k8s.iov1Lease
    +
    Other API versions of this object exist: +v1beta1 +
    +
    Appears In: + +
    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    spec
    LeaseSpec
    Specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    +

    LeaseSpec v1 coordination

    +
    Appears In: + +
    + + + + + + + + + +
    FieldDescription
    acquireTime
    MicroTime
    acquireTime is a time when the current lease was acquired.
    holderIdentity
    string
    holderIdentity contains the identity of the holder of a current lease.
    leaseDurationSeconds
    integer
    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
    integer
    leaseTransitions is the number of transitions of a lease between holders.
    renewTime
    MicroTime
    renewTime is a time when the current holder of a lease has last updated the lease.
    +

    LeaseList v1 coordination

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    Lease array
    Items is a list of schema objects.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    +

    Write Operations

    +

    Create

    +

    create a Lease

    +

    HTTP Request

    +POST /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Lease
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    Lease
    OK
    201
    Lease
    Created
    202
    Lease
    Accepted
    +

    Patch

    +

    partially update the specified Lease

    +

    HTTP Request

    +PATCH /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Lease
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    Lease
    OK
    +

    Replace

    +

    replace the specified Lease

    +

    HTTP Request

    +PUT /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Lease
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Lease
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Lease
    OK
    201
    Lease
    Created
    +

    Delete

    +

    delete a Lease

    +

    HTTP Request

    +DELETE /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Lease
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of Lease

    +

    HTTP Request

    +DELETE /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified Lease

    +

    HTTP Request

    +GET /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Lease
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    Lease
    OK
    +

    List

    +

    list or watch objects of kind Lease

    +

    HTTP Request

    +GET /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    LeaseList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind Lease

    +

    HTTP Request

    +GET /apis/coordination.k8s.io/v1/leases +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    LeaseList
    OK
    +

    Watch

    +

    watch changes to an object of kind Lease. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/coordination.k8s.io/v1/watch/namespaces/{namespace}/leases/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Lease
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of Lease. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/coordination.k8s.io/v1/watch/namespaces/{namespace}/leases +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of Lease. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/coordination.k8s.io/v1/watch/leases +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    LocalSubjectAccessReview v1 authorization.k8s.io

    + + + + + +
    GroupVersionKind
    authorization.k8s.iov1LocalSubjectAccessReview
    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    spec
    SubjectAccessReviewSpec
    Spec holds information about the request being evaluated. spec.namespace must be equal to the namespace you made the request against. If empty, it is defaulted.
    status
    SubjectAccessReviewStatus
    Status is filled in by the server and indicates whether the request is allowed or not
    +

    Write Operations

    +

    Create

    +

    create a LocalSubjectAccessReview

    +

    HTTP Request

    +POST /apis/authorization.k8s.io/v1/namespaces/{namespace}/localsubjectaccessreviews +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    dryRunWhen 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
    fieldManagerfieldManager 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.
    prettyIf 'true', then the output is pretty printed.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    LocalSubjectAccessReview
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    LocalSubjectAccessReview
    OK
    201
    LocalSubjectAccessReview
    Created
    202
    LocalSubjectAccessReview
    Accepted
    +

    Namespace v1 core

    + + + + + +
    GroupVersionKind
    corev1Namespace
    +
    Appears In: + +
    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    spec
    NamespaceSpec
    Spec defines the behavior of the Namespace. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    status
    NamespaceStatus
    Status describes the current status of a Namespace. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    +

    NamespaceSpec v1 core

    +
    Appears In: + +
    + + + + + +
    FieldDescription
    finalizers
    string array
    Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/
    +

    NamespaceStatus v1 core

    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    conditions
    NamespaceCondition array
    patch strategy: merge
    patch merge key: type
    Represents the latest available observations of a namespace's current state.
    phase
    string
    Phase is the current lifecycle phase of the namespace. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/
    +

    NamespaceList v1 core

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    Namespace array
    Items is the list of Namespace objects in the list. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    +

    Write Operations

    +

    Create

    +

    create a Namespace

    +

    HTTP Request

    +POST /api/v1/namespaces +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Namespace
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    Namespace
    OK
    201
    Namespace
    Created
    202
    Namespace
    Accepted
    +

    Patch

    +

    partially update the specified Namespace

    +

    HTTP Request

    +PATCH /api/v1/namespaces/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the Namespace
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    Namespace
    OK
    +

    Replace

    +

    replace the specified Namespace

    +

    HTTP Request

    +PUT /api/v1/namespaces/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the Namespace
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Namespace
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Namespace
    OK
    201
    Namespace
    Created
    +

    Delete

    +

    delete a Namespace

    +

    HTTP Request

    +DELETE /api/v1/namespaces/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the Namespace
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Read Operations

    +

    Read

    +

    read the specified Namespace

    +

    HTTP Request

    +GET /api/v1/namespaces/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the Namespace
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    Namespace
    OK
    +

    List

    +

    list or watch objects of kind Namespace

    +

    HTTP Request

    +GET /api/v1/namespaces +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    NamespaceList
    OK
    +

    Watch

    +

    watch changes to an object of kind Namespace. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /api/v1/watch/namespaces/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the Namespace
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of Namespace. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /api/v1/watch/namespaces +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Status Operations

    +

    Patch Status

    +

    partially update status of the specified Namespace

    +

    HTTP Request

    +PATCH /api/v1/namespaces/{name}/status +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the Namespace
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    Namespace
    OK
    +

    Read Status

    +

    read status of the specified Namespace

    +

    HTTP Request

    +GET /api/v1/namespaces/{name}/status +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the Namespace
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    Namespace
    OK
    +

    Replace Status

    +

    replace status of the specified Namespace

    +

    HTTP Request

    +PUT /api/v1/namespaces/{name}/status +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the Namespace
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Namespace
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Namespace
    OK
    201
    Namespace
    Created
    +

    Node v1 core

    + + + + + +
    GroupVersionKind
    corev1Node
    +
    Appears In: + +
    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    spec
    NodeSpec
    Spec defines the behavior of a node. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    status
    NodeStatus
    Most recently observed status of the node. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    +

    NodeSpec v1 core

    +
    Appears In: + +
    + + + + + + + + + + + +
    FieldDescription
    configSource
    NodeConfigSource
    If specified, the source to get node configuration from The DynamicKubeletConfig feature gate must be enabled for the Kubelet to use this field
    externalID
    string
    Deprecated. Not all kubelets will set this field. Remove field after 1.13. see: https://issues.k8s.io/61966
    podCIDR
    string
    PodCIDR represents the pod IP range assigned to the node.
    podCIDRs
    string array
    patch strategy: merge
    podCIDRs represents the IP ranges assigned to the node for usage by Pods on that node. If this field is specified, the 0th entry must match the podCIDR field. It may contain at most 1 value for each of IPv4 and IPv6.
    providerID
    string
    ID of the node assigned by the cloud provider in the format: <ProviderName>://<ProviderSpecificNodeID>
    taints
    Taint array
    If specified, the node's taints.
    unschedulable
    boolean
    Unschedulable controls node schedulability of new pods. By default, node is schedulable. More info: https://kubernetes.io/docs/concepts/nodes/node/#manual-node-administration
    +

    NodeStatus v1 core

    +
    Appears In: + +
    + + + + + + + + + + + + + + + +
    FieldDescription
    addresses
    NodeAddress array
    patch strategy: merge
    patch merge 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 http://pr.k8s.io/79391 for an example.
    allocatable
    object
    Allocatable represents the resources of a node that are available for scheduling. Defaults to Capacity.
    capacity
    object
    Capacity represents the total resources of a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity
    conditions
    NodeCondition array
    patch strategy: merge
    patch merge key: type
    Conditions is an array of current observed node conditions. More info: https://kubernetes.io/docs/concepts/nodes/node/#condition
    config
    NodeConfigStatus
    Status of the config assigned to the node via the dynamic Kubelet config feature.
    daemonEndpoints
    NodeDaemonEndpoints
    Endpoints of daemons running on the Node.
    images
    ContainerImage array
    List of container images on this node
    nodeInfo
    NodeSystemInfo
    Set of ids/uuids to uniquely identify the node. More info: https://kubernetes.io/docs/concepts/nodes/node/#info
    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 array
    List of volumes that are attached to the node.
    volumesInUse
    string array
    List of attachable volumes in use (mounted) by the node.
    +

    NodeList v1 core

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    Node array
    List of nodes
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    +

    Write Operations

    +

    Create

    +

    create a Node

    +

    HTTP Request

    +POST /api/v1/nodes +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Node
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    Node
    OK
    201
    Node
    Created
    202
    Node
    Accepted
    +

    Patch

    +

    partially update the specified Node

    +

    HTTP Request

    +PATCH /api/v1/nodes/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the Node
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    Node
    OK
    +

    Replace

    +

    replace the specified Node

    +

    HTTP Request

    +PUT /api/v1/nodes/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the Node
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Node
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Node
    OK
    201
    Node
    Created
    +

    Delete

    +

    delete a Node

    +

    HTTP Request

    +DELETE /api/v1/nodes/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the Node
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of Node

    +

    HTTP Request

    +DELETE /api/v1/nodes +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified Node

    +

    HTTP Request

    +GET /api/v1/nodes/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the Node
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    Node
    OK
    +

    List

    +

    list or watch objects of kind Node

    +

    HTTP Request

    +GET /api/v1/nodes +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    NodeList
    OK
    +

    Watch

    +

    watch changes to an object of kind Node. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /api/v1/watch/nodes/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the Node
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of Node. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /api/v1/watch/nodes +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Status Operations

    +

    Patch Status

    +

    partially update status of the specified Node

    +

    HTTP Request

    +PATCH /api/v1/nodes/{name}/status +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the Node
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    Node
    OK
    +

    Read Status

    +

    read status of the specified Node

    +

    HTTP Request

    +GET /api/v1/nodes/{name}/status +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the Node
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    Node
    OK
    +

    Replace Status

    +

    replace status of the specified Node

    +

    HTTP Request

    +PUT /api/v1/nodes/{name}/status +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the Node
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Node
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Node
    OK
    201
    Node
    Created
    +

    Proxy Operations

    +

    Create Connect Proxy

    +

    connect POST requests to proxy of Node

    +

    HTTP Request

    +POST /api/v1/nodes/{name}/proxy +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the NodeProxyOptions
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    pathPath is the URL path to use for the current proxy request to node.
    +

    Response

    + + + + + +
    CodeDescription
    200
    string
    OK
    +

    Create Connect Proxy Path

    +

    connect POST requests to proxy of Node

    +

    HTTP Request

    +POST /api/v1/nodes/{name}/proxy/{path} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the NodeProxyOptions
    pathpath to the resource
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    pathPath is the URL path to use for the current proxy request to node.
    +

    Response

    + + + + + +
    CodeDescription
    200
    string
    OK
    +

    Delete Connect Proxy

    +

    connect DELETE requests to proxy of Node

    +

    HTTP Request

    +DELETE /api/v1/nodes/{name}/proxy +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the NodeProxyOptions
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    pathPath is the URL path to use for the current proxy request to node.
    +

    Response

    + + + + + +
    CodeDescription
    200
    string
    OK
    +

    Delete Connect Proxy Path

    +

    connect DELETE requests to proxy of Node

    +

    HTTP Request

    +DELETE /api/v1/nodes/{name}/proxy/{path} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the NodeProxyOptions
    pathpath to the resource
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    pathPath is the URL path to use for the current proxy request to node.
    +

    Response

    + + + + + +
    CodeDescription
    200
    string
    OK
    +

    Get Connect Proxy

    +

    connect GET requests to proxy of Node

    +

    HTTP Request

    +GET /api/v1/nodes/{name}/proxy +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the NodeProxyOptions
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    pathPath is the URL path to use for the current proxy request to node.
    +

    Response

    + + + + + +
    CodeDescription
    200
    string
    OK
    +

    Get Connect Proxy Path

    +

    connect GET requests to proxy of Node

    +

    HTTP Request

    +GET /api/v1/nodes/{name}/proxy/{path} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the NodeProxyOptions
    pathpath to the resource
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    pathPath is the URL path to use for the current proxy request to node.
    +

    Response

    + + + + + +
    CodeDescription
    200
    string
    OK
    +

    Head Connect Proxy

    +

    connect HEAD requests to proxy of Node

    +

    HTTP Request

    +HEAD /api/v1/nodes/{name}/proxy +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the NodeProxyOptions
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    pathPath is the URL path to use for the current proxy request to node.
    +

    Response

    + + + + + +
    CodeDescription
    200
    string
    OK
    +

    Head Connect Proxy Path

    +

    connect HEAD requests to proxy of Node

    +

    HTTP Request

    +HEAD /api/v1/nodes/{name}/proxy/{path} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the NodeProxyOptions
    pathpath to the resource
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    pathPath is the URL path to use for the current proxy request to node.
    +

    Response

    + + + + + +
    CodeDescription
    200
    string
    OK
    +

    Replace Connect Proxy

    +

    connect PUT requests to proxy of Node

    +

    HTTP Request

    +PUT /api/v1/nodes/{name}/proxy +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the NodeProxyOptions
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    pathPath is the URL path to use for the current proxy request to node.
    +

    Response

    + + + + + +
    CodeDescription
    200
    string
    OK
    +

    Replace Connect Proxy Path

    +

    connect PUT requests to proxy of Node

    +

    HTTP Request

    +PUT /api/v1/nodes/{name}/proxy/{path} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the NodeProxyOptions
    pathpath to the resource
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    pathPath is the URL path to use for the current proxy request to node.
    +

    Response

    + + + + + +
    CodeDescription
    200
    string
    OK
    +

    PersistentVolume v1 core

    + + + + + +
    GroupVersionKind
    corev1PersistentVolume
    +
    These are assigned to Pods using PersistentVolumeClaims.
    +
    Appears In: + +
    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    spec
    PersistentVolumeSpec
    Spec defines a specification of a persistent volume owned by the cluster. Provisioned by an administrator. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistent-volumes
    status
    PersistentVolumeStatus
    Status represents the current information/status for the persistent volume. Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistent-volumes
    +

    PersistentVolumeSpec v1 core

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    accessModes
    string array
    AccessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes
    awsElasticBlockStore
    AWSElasticBlockStoreVolumeSource
    AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
    azureDisk
    AzureDiskVolumeSource
    AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
    azureFile
    AzureFilePersistentVolumeSource
    AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
    capacity
    object
    A description of the persistent volume's resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity
    cephfs
    CephFSPersistentVolumeSource
    CephFS represents a Ceph FS mount on the host that shares a pod's lifetime
    cinder
    CinderPersistentVolumeSource
    Cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
    claimRef
    ObjectReference
    ClaimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. Expected to be non-nil when bound. claim.VolumeName is the authoritative bind between PV and PVC. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding
    csi
    CSIPersistentVolumeSource
    CSI represents storage that is handled by an external CSI driver (Beta feature).
    fc
    FCVolumeSource
    FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
    flexVolume
    FlexPersistentVolumeSource
    FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
    flocker
    FlockerVolumeSource
    Flocker represents a Flocker volume attached to a kubelet's host machine and exposed to the pod for its usage. This depends on the Flocker control service being running
    gcePersistentDisk
    GCEPersistentDiskVolumeSource
    GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin. 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
    hostPath
    HostPathVolumeSource
    HostPath represents a directory on the host. Provisioned by a developer or tester. This is useful for single-node development and testing only! On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
    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.
    local
    LocalVolumeSource
    Local represents directly-attached storage with node affinity
    mountOptions
    string array
    A list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options
    nfs
    NFSVolumeSource
    NFS represents an NFS mount on the host. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
    nodeAffinity
    VolumeNodeAffinity
    NodeAffinity defines constraints that limit what nodes this volume can be accessed from. This field influences the scheduling of pods that use this volume.
    persistentVolumeReclaimPolicy
    string
    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
    photonPersistentDisk
    PhotonPersistentDiskVolumeSource
    PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
    portworxVolume
    PortworxVolumeSource
    PortworxVolume represents a portworx volume attached and mounted on kubelets host machine
    quobyte
    QuobyteVolumeSource
    Quobyte represents a Quobyte mount on the host that shares a pod's lifetime
    rbd
    RBDPersistentVolumeSource
    RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md
    scaleIO
    ScaleIOPersistentVolumeSource
    ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
    storageClassName
    string
    Name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass.
    storageos
    StorageOSPersistentVolumeSource
    StorageOS represents a StorageOS volume that is attached to the kubelet's host machine and mounted into the pod More info: https://examples.k8s.io/volumes/storageos/README.md
    volumeMode
    string
    volumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state. Value of Filesystem is implied when not included in spec.
    vsphereVolume
    VsphereVirtualDiskVolumeSource
    VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
    +

    PersistentVolumeStatus v1 core

    +
    Appears In: + +
    + + + + + + + +
    FieldDescription
    message
    string
    A human-readable message indicating details about why the volume is in this state.
    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
    Reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI.
    +

    PersistentVolumeList v1 core

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    PersistentVolume array
    List of persistent volumes. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    +

    Write Operations

    +

    Create

    +

    create a PersistentVolume

    +

    HTTP Request

    +POST /api/v1/persistentvolumes +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    PersistentVolume
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    PersistentVolume
    OK
    201
    PersistentVolume
    Created
    202
    PersistentVolume
    Accepted
    +

    Patch

    +

    partially update the specified PersistentVolume

    +

    HTTP Request

    +PATCH /api/v1/persistentvolumes/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the PersistentVolume
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    PersistentVolume
    OK
    +

    Replace

    +

    replace the specified PersistentVolume

    +

    HTTP Request

    +PUT /api/v1/persistentvolumes/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the PersistentVolume
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    PersistentVolume
    +

    Response

    + + + + + + +
    CodeDescription
    200
    PersistentVolume
    OK
    201
    PersistentVolume
    Created
    +

    Delete

    +

    delete a PersistentVolume

    +

    HTTP Request

    +DELETE /api/v1/persistentvolumes/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the PersistentVolume
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    PersistentVolume
    OK
    202
    PersistentVolume
    Accepted
    +

    Delete Collection

    +

    delete collection of PersistentVolume

    +

    HTTP Request

    +DELETE /api/v1/persistentvolumes +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified PersistentVolume

    +

    HTTP Request

    +GET /api/v1/persistentvolumes/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the PersistentVolume
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    PersistentVolume
    OK
    +

    List

    +

    list or watch objects of kind PersistentVolume

    +

    HTTP Request

    +GET /api/v1/persistentvolumes +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    PersistentVolumeList
    OK
    +

    Watch

    +

    watch changes to an object of kind PersistentVolume. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /api/v1/watch/persistentvolumes/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the PersistentVolume
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of PersistentVolume. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /api/v1/watch/persistentvolumes +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Status Operations

    +

    Patch Status

    +

    partially update status of the specified PersistentVolume

    +

    HTTP Request

    +PATCH /api/v1/persistentvolumes/{name}/status +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the PersistentVolume
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    PersistentVolume
    OK
    +

    Read Status

    +

    read status of the specified PersistentVolume

    +

    HTTP Request

    +GET /api/v1/persistentvolumes/{name}/status +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the PersistentVolume
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    PersistentVolume
    OK
    +

    Replace Status

    +

    replace status of the specified PersistentVolume

    +

    HTTP Request

    +PUT /api/v1/persistentvolumes/{name}/status +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the PersistentVolume
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    PersistentVolume
    +

    Response

    + + + + + + +
    CodeDescription
    200
    PersistentVolume
    OK
    201
    PersistentVolume
    Created
    +

    PriorityLevelConfiguration v1beta1 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta1PriorityLevelConfiguration
    + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    `metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    spec
    PriorityLevelConfigurationSpec
    `spec` is the specification of the desired behavior of a "request-priority". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    status
    PriorityLevelConfigurationStatus
    `status` is the current status of a "request-priority". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    +

    PriorityLevelConfigurationSpec v1beta1 flowcontrol

    + + + + + + + +
    FieldDescription
    limited
    LimitedPriorityLevelConfiguration
    `limited` specifies how requests are handled for a Limited priority level. This field must be non-empty if and only if `type` is `"Limited"`.
    type
    string
    `type` indicates whether this priority level is subject to limitation on request execution. A value of `"Exempt"` means that requests of this priority level are not subject to a limit (and thus are never queued) and do not detract from the capacity made available to other priority levels. A value of `"Limited"` means that (a) requests of this priority level _are_ subject to limits and (b) some of the server's limited capacity is made available exclusively to this priority level. Required.
    +

    PriorityLevelConfigurationStatus v1beta1 flowcontrol

    + + + + + + +
    FieldDescription
    conditions
    PriorityLevelConfigurationCondition array
    `conditions` is the current state of "request-priority".
    +

    PriorityLevelConfigurationList v1beta1 flowcontrol

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    PriorityLevelConfiguration array
    `items` is a list of request-priorities.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    `metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    +

    Write Operations

    +

    Create

    +

    create a PriorityLevelConfiguration

    +

    HTTP Request

    +POST /apis/flowcontrol.apiserver.k8s.io/v1beta1/prioritylevelconfigurations +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    PriorityLevelConfiguration
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    PriorityLevelConfiguration
    OK
    201
    PriorityLevelConfiguration
    Created
    202
    PriorityLevelConfiguration
    Accepted
    +

    Patch

    +

    partially update the specified PriorityLevelConfiguration

    +

    HTTP Request

    +PATCH /apis/flowcontrol.apiserver.k8s.io/v1beta1/prioritylevelconfigurations/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the PriorityLevelConfiguration
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    PriorityLevelConfiguration
    OK
    +

    Replace

    +

    replace the specified PriorityLevelConfiguration

    +

    HTTP Request

    +PUT /apis/flowcontrol.apiserver.k8s.io/v1beta1/prioritylevelconfigurations/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the PriorityLevelConfiguration
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    PriorityLevelConfiguration
    +

    Response

    + + + + + + +
    CodeDescription
    200
    PriorityLevelConfiguration
    OK
    201
    PriorityLevelConfiguration
    Created
    +

    Delete

    +

    delete a PriorityLevelConfiguration

    +

    HTTP Request

    +DELETE /apis/flowcontrol.apiserver.k8s.io/v1beta1/prioritylevelconfigurations/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the PriorityLevelConfiguration
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of PriorityLevelConfiguration

    +

    HTTP Request

    +DELETE /apis/flowcontrol.apiserver.k8s.io/v1beta1/prioritylevelconfigurations +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified PriorityLevelConfiguration

    +

    HTTP Request

    +GET /apis/flowcontrol.apiserver.k8s.io/v1beta1/prioritylevelconfigurations/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the PriorityLevelConfiguration
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    PriorityLevelConfiguration
    OK
    +

    List

    +

    list or watch objects of kind PriorityLevelConfiguration

    +

    HTTP Request

    +GET /apis/flowcontrol.apiserver.k8s.io/v1beta1/prioritylevelconfigurations +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    PriorityLevelConfigurationList
    OK
    +

    Watch

    +

    watch changes to an object of kind PriorityLevelConfiguration. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/flowcontrol.apiserver.k8s.io/v1beta1/watch/prioritylevelconfigurations/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the PriorityLevelConfiguration
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of PriorityLevelConfiguration. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/flowcontrol.apiserver.k8s.io/v1beta1/watch/prioritylevelconfigurations +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Status Operations

    +

    Patch Status

    +

    partially update status of the specified PriorityLevelConfiguration

    +

    HTTP Request

    +PATCH /apis/flowcontrol.apiserver.k8s.io/v1beta1/prioritylevelconfigurations/{name}/status +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the PriorityLevelConfiguration
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    PriorityLevelConfiguration
    OK
    +

    Read Status

    +

    read status of the specified PriorityLevelConfiguration

    +

    HTTP Request

    +GET /apis/flowcontrol.apiserver.k8s.io/v1beta1/prioritylevelconfigurations/{name}/status +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the PriorityLevelConfiguration
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    PriorityLevelConfiguration
    OK
    +

    Replace Status

    +

    replace status of the specified PriorityLevelConfiguration

    +

    HTTP Request

    +PUT /apis/flowcontrol.apiserver.k8s.io/v1beta1/prioritylevelconfigurations/{name}/status +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the PriorityLevelConfiguration
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    PriorityLevelConfiguration
    +

    Response

    + + + + + + +
    CodeDescription
    200
    PriorityLevelConfiguration
    OK
    201
    PriorityLevelConfiguration
    Created
    +

    ResourceQuota v1 core

    + + + + + +
    GroupVersionKind
    corev1ResourceQuota
    +
    Appears In: + +
    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    spec
    ResourceQuotaSpec
    Spec defines the desired quota. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    status
    ResourceQuotaStatus
    Status defines the actual enforced quota and its current usage. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    +

    ResourceQuotaSpec v1 core

    +
    Appears In: + +
    + + + + + + + +
    FieldDescription
    hard
    object
    hard is the set of desired hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/
    scopeSelector
    ScopeSelector
    scopeSelector is also a collection of filters like scopes that must match each object tracked by a quota but expressed using ScopeSelectorOperator in combination with possible values. For a resource to match, both scopes AND scopeSelector (if specified in spec), must be matched.
    scopes
    string array
    A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects.
    +

    ResourceQuotaStatus v1 core

    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    hard
    object
    Hard is the set of enforced hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/
    used
    object
    Used is the current observed total usage of the resource in the namespace.
    +

    ResourceQuotaList v1 core

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    ResourceQuota array
    Items is a list of ResourceQuota objects. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    +

    Write Operations

    +

    Create

    +

    create a ResourceQuota

    +

    HTTP Request

    +POST /api/v1/namespaces/{namespace}/resourcequotas +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    ResourceQuota
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    ResourceQuota
    OK
    201
    ResourceQuota
    Created
    202
    ResourceQuota
    Accepted
    +

    Patch

    +

    partially update the specified ResourceQuota

    +

    HTTP Request

    +PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ResourceQuota
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    ResourceQuota
    OK
    +

    Replace

    +

    replace the specified ResourceQuota

    +

    HTTP Request

    +PUT /api/v1/namespaces/{namespace}/resourcequotas/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ResourceQuota
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    ResourceQuota
    +

    Response

    + + + + + + +
    CodeDescription
    200
    ResourceQuota
    OK
    201
    ResourceQuota
    Created
    +

    Delete

    +

    delete a ResourceQuota

    +

    HTTP Request

    +DELETE /api/v1/namespaces/{namespace}/resourcequotas/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ResourceQuota
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    ResourceQuota
    OK
    202
    ResourceQuota
    Accepted
    +

    Delete Collection

    +

    delete collection of ResourceQuota

    +

    HTTP Request

    +DELETE /api/v1/namespaces/{namespace}/resourcequotas +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified ResourceQuota

    +

    HTTP Request

    +GET /api/v1/namespaces/{namespace}/resourcequotas/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ResourceQuota
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    ResourceQuota
    OK
    +

    List

    +

    list or watch objects of kind ResourceQuota

    +

    HTTP Request

    +GET /api/v1/namespaces/{namespace}/resourcequotas +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    ResourceQuotaList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind ResourceQuota

    +

    HTTP Request

    +GET /api/v1/resourcequotas +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    ResourceQuotaList
    OK
    +

    Watch

    +

    watch changes to an object of kind ResourceQuota. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /api/v1/watch/namespaces/{namespace}/resourcequotas/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ResourceQuota
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of ResourceQuota. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /api/v1/watch/namespaces/{namespace}/resourcequotas +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of ResourceQuota. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /api/v1/watch/resourcequotas +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Status Operations

    +

    Patch Status

    +

    partially update status of the specified ResourceQuota

    +

    HTTP Request

    +PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ResourceQuota
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    ResourceQuota
    OK
    +

    Read Status

    +

    read status of the specified ResourceQuota

    +

    HTTP Request

    +GET /api/v1/namespaces/{namespace}/resourcequotas/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ResourceQuota
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    ResourceQuota
    OK
    +

    Replace Status

    +

    replace status of the specified ResourceQuota

    +

    HTTP Request

    +PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ResourceQuota
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    ResourceQuota
    +

    Response

    + + + + + + +
    CodeDescription
    200
    ResourceQuota
    OK
    201
    ResourceQuota
    Created
    +

    Role v1 rbac.authorization.k8s.io

    + + + + + +
    GroupVersionKind
    rbac.authorization.k8s.iov1Role
    +
    Other API versions of this object exist: +v1beta1 +v1alpha1 +
    +
    Appears In: + +
    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata.
    rules
    PolicyRule array
    Rules holds all the PolicyRules for this Role
    +

    RoleList v1 rbac

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    Role array
    Items is a list of Roles
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard object's metadata.
    +

    Write Operations

    +

    Create

    +

    create a Role

    +

    HTTP Request

    +POST /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Role
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    Role
    OK
    201
    Role
    Created
    202
    Role
    Accepted
    +

    Patch

    +

    partially update the specified Role

    +

    HTTP Request

    +PATCH /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Role
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    Role
    OK
    +

    Replace

    +

    replace the specified Role

    +

    HTTP Request

    +PUT /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Role
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Role
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Role
    OK
    201
    Role
    Created
    +

    Delete

    +

    delete a Role

    +

    HTTP Request

    +DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Role
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of Role

    +

    HTTP Request

    +DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified Role

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Role
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    Role
    OK
    +

    List

    +

    list or watch objects of kind Role

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    RoleList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind Role

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1/roles +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    RoleList
    OK
    +

    Watch

    +

    watch changes to an object of kind Role. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/roles/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Role
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of Role. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/roles +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of Role. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1/watch/roles +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    RoleBinding v1 rbac.authorization.k8s.io

    + + + + + +
    GroupVersionKind
    rbac.authorization.k8s.iov1RoleBinding
    +
    Other API versions of this object exist: +v1beta1 +v1alpha1 +
    +
    Appears In: + +
    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata.
    roleRef
    RoleRef
    RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.
    subjects
    Subject array
    Subjects holds references to the objects the role applies to.
    +

    RoleBindingList v1 rbac

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    RoleBinding array
    Items is a list of RoleBindings
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard object's metadata.
    +

    Write Operations

    +

    Create

    +

    create a RoleBinding

    +

    HTTP Request

    +POST /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    RoleBinding
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    RoleBinding
    OK
    201
    RoleBinding
    Created
    202
    RoleBinding
    Accepted
    +

    Patch

    +

    partially update the specified RoleBinding

    +

    HTTP Request

    +PATCH /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the RoleBinding
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    RoleBinding
    OK
    +

    Replace

    +

    replace the specified RoleBinding

    +

    HTTP Request

    +PUT /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the RoleBinding
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    RoleBinding
    +

    Response

    + + + + + + +
    CodeDescription
    200
    RoleBinding
    OK
    201
    RoleBinding
    Created
    +

    Delete

    +

    delete a RoleBinding

    +

    HTTP Request

    +DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the RoleBinding
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of RoleBinding

    +

    HTTP Request

    +DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified RoleBinding

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the RoleBinding
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    RoleBinding
    OK
    +

    List

    +

    list or watch objects of kind RoleBinding

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    RoleBindingList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind RoleBinding

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1/rolebindings +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    RoleBindingList
    OK
    +

    Watch

    +

    watch changes to an object of kind RoleBinding. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/rolebindings/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the RoleBinding
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of RoleBinding. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/rolebindings +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of RoleBinding. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1/watch/rolebindings +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    RuntimeClass v1 node.k8s.io

    + + + + + +
    GroupVersionKind
    node.k8s.iov1RuntimeClass
    +
    Other API versions of this object exist: +v1beta1 +v1alpha1 +
    +
    Appears In: + +
    + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    handler
    string
    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.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    overhead
    Overhead
    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/ This field is in beta starting v1.18 and is only honored by servers that enable the PodOverhead feature.
    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.
    +

    RuntimeClassList v1 node

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    RuntimeClass array
    Items is a list of schema objects.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    +

    Write Operations

    +

    Create

    +

    create a RuntimeClass

    +

    HTTP Request

    +POST /apis/node.k8s.io/v1/runtimeclasses +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    RuntimeClass
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    RuntimeClass
    OK
    201
    RuntimeClass
    Created
    202
    RuntimeClass
    Accepted
    +

    Patch

    +

    partially update the specified RuntimeClass

    +

    HTTP Request

    +PATCH /apis/node.k8s.io/v1/runtimeclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the RuntimeClass
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    RuntimeClass
    OK
    +

    Replace

    +

    replace the specified RuntimeClass

    +

    HTTP Request

    +PUT /apis/node.k8s.io/v1/runtimeclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the RuntimeClass
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    RuntimeClass
    +

    Response

    + + + + + + +
    CodeDescription
    200
    RuntimeClass
    OK
    201
    RuntimeClass
    Created
    +

    Delete

    +

    delete a RuntimeClass

    +

    HTTP Request

    +DELETE /apis/node.k8s.io/v1/runtimeclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the RuntimeClass
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of RuntimeClass

    +

    HTTP Request

    +DELETE /apis/node.k8s.io/v1/runtimeclasses +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified RuntimeClass

    +

    HTTP Request

    +GET /apis/node.k8s.io/v1/runtimeclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the RuntimeClass
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    RuntimeClass
    OK
    +

    List

    +

    list or watch objects of kind RuntimeClass

    +

    HTTP Request

    +GET /apis/node.k8s.io/v1/runtimeclasses +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    RuntimeClassList
    OK
    +

    Watch

    +

    watch changes to an object of kind RuntimeClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/node.k8s.io/v1/watch/runtimeclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the RuntimeClass
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of RuntimeClass. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/node.k8s.io/v1/watch/runtimeclasses +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    SelfSubjectAccessReview v1 authorization.k8s.io

    + + + + + +
    GroupVersionKind
    authorization.k8s.iov1SelfSubjectAccessReview
    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    spec
    SelfSubjectAccessReviewSpec
    Spec holds information about the request being evaluated. user and groups must be empty
    status
    SubjectAccessReviewStatus
    Status is filled in by the server and indicates whether the request is allowed or not
    +

    SelfSubjectAccessReviewSpec v1 authorization

    + + + + + + + +
    FieldDescription
    nonResourceAttributes
    NonResourceAttributes
    NonResourceAttributes describes information for a non-resource access request
    resourceAttributes
    ResourceAttributes
    ResourceAuthorizationAttributes describes information for a resource access request
    +

    Write Operations

    +

    Create

    +

    create a SelfSubjectAccessReview

    +

    HTTP Request

    +POST /apis/authorization.k8s.io/v1/selfsubjectaccessreviews +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    dryRunWhen 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
    fieldManagerfieldManager 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.
    prettyIf 'true', then the output is pretty printed.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    SelfSubjectAccessReview
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    SelfSubjectAccessReview
    OK
    201
    SelfSubjectAccessReview
    Created
    202
    SelfSubjectAccessReview
    Accepted
    +

    SelfSubjectRulesReview v1 authorization.k8s.io

    + + + + + +
    GroupVersionKind
    authorization.k8s.iov1SelfSubjectRulesReview
    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    spec
    SelfSubjectRulesReviewSpec
    Spec holds information about the request being evaluated.
    status
    SubjectRulesReviewStatus
    Status is filled in by the server and indicates the set of actions a user can perform.
    +

    SelfSubjectRulesReviewSpec v1 authorization

    + + + + + + +
    FieldDescription
    namespace
    string
    Namespace to evaluate rules for. Required.
    +

    Write Operations

    +

    Create

    +

    create a SelfSubjectRulesReview

    +

    HTTP Request

    +POST /apis/authorization.k8s.io/v1/selfsubjectrulesreviews +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    dryRunWhen 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
    fieldManagerfieldManager 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.
    prettyIf 'true', then the output is pretty printed.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    SelfSubjectRulesReview
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    SelfSubjectRulesReview
    OK
    201
    SelfSubjectRulesReview
    Created
    202
    SelfSubjectRulesReview
    Accepted
    +

    ServiceAccount v1 core

    + + + + + +
    GroupVersionKind
    corev1ServiceAccount
    +
    Appears In: + +
    + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    automountServiceAccountToken
    boolean
    AutomountServiceAccountToken indicates whether pods running as this service account should have an API token automatically mounted. Can be overridden at the pod level.
    imagePullSecrets
    LocalObjectReference array
    ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    secrets
    ObjectReference array
    patch strategy: merge
    patch merge key: name
    Secrets is the list of secrets allowed to be used by pods running using this ServiceAccount. More info: https://kubernetes.io/docs/concepts/configuration/secret
    +

    ServiceAccountList v1 core

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    ServiceAccount array
    List of ServiceAccounts. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    +

    Write Operations

    +

    Create

    +

    create a ServiceAccount

    +

    HTTP Request

    +POST /api/v1/namespaces/{namespace}/serviceaccounts +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    ServiceAccount
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    ServiceAccount
    OK
    201
    ServiceAccount
    Created
    202
    ServiceAccount
    Accepted
    +

    Patch

    +

    partially update the specified ServiceAccount

    +

    HTTP Request

    +PATCH /api/v1/namespaces/{namespace}/serviceaccounts/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ServiceAccount
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    ServiceAccount
    OK
    +

    Replace

    +

    replace the specified ServiceAccount

    +

    HTTP Request

    +PUT /api/v1/namespaces/{namespace}/serviceaccounts/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ServiceAccount
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    ServiceAccount
    +

    Response

    + + + + + + +
    CodeDescription
    200
    ServiceAccount
    OK
    201
    ServiceAccount
    Created
    +

    Delete

    +

    delete a ServiceAccount

    +

    HTTP Request

    +DELETE /api/v1/namespaces/{namespace}/serviceaccounts/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ServiceAccount
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    ServiceAccount
    OK
    202
    ServiceAccount
    Accepted
    +

    Delete Collection

    +

    delete collection of ServiceAccount

    +

    HTTP Request

    +DELETE /api/v1/namespaces/{namespace}/serviceaccounts +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified ServiceAccount

    +

    HTTP Request

    +GET /api/v1/namespaces/{namespace}/serviceaccounts/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ServiceAccount
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    ServiceAccount
    OK
    +

    List

    +

    list or watch objects of kind ServiceAccount

    +

    HTTP Request

    +GET /api/v1/namespaces/{namespace}/serviceaccounts +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    ServiceAccountList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind ServiceAccount

    +

    HTTP Request

    +GET /api/v1/serviceaccounts +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    ServiceAccountList
    OK
    +

    Watch

    +

    watch changes to an object of kind ServiceAccount. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /api/v1/watch/namespaces/{namespace}/serviceaccounts/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the ServiceAccount
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of ServiceAccount. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /api/v1/watch/namespaces/{namespace}/serviceaccounts +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of ServiceAccount. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /api/v1/watch/serviceaccounts +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    StorageVersion v1alpha1 internal.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    internal.apiserver.k8s.iov1alpha1StorageVersion
    + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    The name is <group>.<resource>.
    spec
    StorageVersionSpec
    Spec is an empty spec. It is here to comply with Kubernetes API style.
    status
    StorageVersionStatus
    API server instances report the version they can decode and the version they encode objects to when persisting objects in the backend.
    +

    StorageVersionSpec v1alpha1 apiserverinternal

    + + + + + +
    FieldDescription
    +

    StorageVersionStatus v1alpha1 apiserverinternal

    + + + + + + + + +
    FieldDescription
    commonEncodingVersion
    string
    If all API server instances agree on the same encoding storage version, then this field is set to that version. Otherwise this field is left empty. API servers should finish updating its storageVersionStatus entry before serving write operations, so that this field will be in sync with the reality.
    conditions
    StorageVersionCondition array
    The latest available observations of the storageVersion's state.
    storageVersions
    ServerStorageVersion array
    The reported versions per API server instance.
    +

    StorageVersionList v1alpha1 apiserverinternal

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    StorageVersion array
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    +

    Write Operations

    +

    Create

    +

    create a StorageVersion

    +

    HTTP Request

    +POST /apis/internal.apiserver.k8s.io/v1alpha1/storageversions +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    StorageVersion
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    StorageVersion
    OK
    201
    StorageVersion
    Created
    202
    StorageVersion
    Accepted
    +

    Patch

    +

    partially update the specified StorageVersion

    +

    HTTP Request

    +PATCH /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the StorageVersion
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    StorageVersion
    OK
    +

    Replace

    +

    replace the specified StorageVersion

    +

    HTTP Request

    +PUT /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the StorageVersion
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    StorageVersion
    +

    Response

    + + + + + + +
    CodeDescription
    200
    StorageVersion
    OK
    201
    StorageVersion
    Created
    +

    Delete

    +

    delete a StorageVersion

    +

    HTTP Request

    +DELETE /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the StorageVersion
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of StorageVersion

    +

    HTTP Request

    +DELETE /apis/internal.apiserver.k8s.io/v1alpha1/storageversions +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified StorageVersion

    +

    HTTP Request

    +GET /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the StorageVersion
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    StorageVersion
    OK
    +

    List

    +

    list or watch objects of kind StorageVersion

    +

    HTTP Request

    +GET /apis/internal.apiserver.k8s.io/v1alpha1/storageversions +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    StorageVersionList
    OK
    +

    Watch

    +

    watch changes to an object of kind StorageVersion. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/internal.apiserver.k8s.io/v1alpha1/watch/storageversions/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the StorageVersion
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of StorageVersion. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/internal.apiserver.k8s.io/v1alpha1/watch/storageversions +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Status Operations

    +

    Patch Status

    +

    partially update status of the specified StorageVersion

    +

    HTTP Request

    +PATCH /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name}/status +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the StorageVersion
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    StorageVersion
    OK
    +

    Read Status

    +

    read status of the specified StorageVersion

    +

    HTTP Request

    +GET /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name}/status +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the StorageVersion
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    StorageVersion
    OK
    +

    Replace Status

    +

    replace status of the specified StorageVersion

    +

    HTTP Request

    +PUT /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name}/status +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the StorageVersion
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    StorageVersion
    +

    Response

    + + + + + + +
    CodeDescription
    200
    StorageVersion
    OK
    201
    StorageVersion
    Created
    +

    SubjectAccessReview v1 authorization.k8s.io

    + + + + + +
    GroupVersionKind
    authorization.k8s.iov1SubjectAccessReview
    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    spec
    SubjectAccessReviewSpec
    Spec holds information about the request being evaluated
    status
    SubjectAccessReviewStatus
    Status is filled in by the server and indicates whether the request is allowed or not
    +

    SubjectAccessReviewSpec v1 authorization

    + + + + + + + + + + + +
    FieldDescription
    extra
    object
    Extra corresponds to the user.Info.GetExtra() method from the authenticator. Since that is input to the authorizer it needs a reflection here.
    groups
    string array
    Groups is the groups you're testing for.
    nonResourceAttributes
    NonResourceAttributes
    NonResourceAttributes describes information for a non-resource access request
    resourceAttributes
    ResourceAttributes
    ResourceAuthorizationAttributes describes information for a resource access request
    uid
    string
    UID information about the requesting user.
    user
    string
    User is the user you're testing for. If you specify "User" but not "Groups", then is it interpreted as "What if User were not a member of any groups
    +

    SubjectAccessReviewStatus v1 authorization

    + + + + + + + + + +
    FieldDescription
    allowed
    boolean
    Allowed is required. True if the action would be allowed, false otherwise.
    denied
    boolean
    Denied is optional. True if the action would be denied, otherwise false. If both allowed is false and denied is false, then the authorizer has no opinion on whether to authorize the action. Denied may not be true if Allowed is true.
    evaluationError
    string
    EvaluationError is an indication that some error occurred during the authorization check. It is entirely possible to get an error and be able to continue determine authorization status in spite of it. For instance, RBAC can be missing a role, but enough roles are still present and bound to reason about the request.
    reason
    string
    Reason is optional. It indicates why a request was allowed or denied.
    +

    Write Operations

    +

    Create

    +

    create a SubjectAccessReview

    +

    HTTP Request

    +POST /apis/authorization.k8s.io/v1/subjectaccessreviews +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    dryRunWhen 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
    fieldManagerfieldManager 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.
    prettyIf 'true', then the output is pretty printed.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    SubjectAccessReview
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    SubjectAccessReview
    OK
    201
    SubjectAccessReview
    Created
    202
    SubjectAccessReview
    Accepted
    +

    TokenRequest v1 authentication.k8s.io

    + + + + + +
    GroupVersionKind
    authentication.k8s.iov1TokenRequest
    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    spec
    TokenRequestSpec
    status
    TokenRequestStatus
    +

    TokenRequestSpec v1 authentication

    + + + + + + + + +
    FieldDescription
    audiences
    string array
    Audiences are the intendend audiences of the token. A recipient of a token must identitfy themself with an identifier in the list of audiences of the token, and otherwise should reject the token. A token issued for multiple audiences may be used to authenticate against any of the audiences listed but implies a high degree of trust between the target audiences.
    boundObjectRef
    BoundObjectReference
    BoundObjectRef is a reference to an object that the token will be bound to. The token will only be valid for as long as the bound object exists. NOTE: The API server's TokenReview endpoint will validate the BoundObjectRef, but other audiences may not. Keep ExpirationSeconds small if you want prompt revocation.
    expirationSeconds
    integer
    ExpirationSeconds is the requested duration of validity of the request. The token issuer may return a token with a different validity duration so a client needs to check the 'expiration' field in a response.
    +

    TokenRequestStatus v1 authentication

    + + + + + + + +
    FieldDescription
    expirationTimestamp
    Time
    ExpirationTimestamp is the time of expiration of the returned token.
    token
    string
    Token is the opaque bearer token.
    +

    TokenReview v1 authentication.k8s.io

    + + + + + +
    GroupVersionKind
    authentication.k8s.iov1TokenReview
    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    spec
    TokenReviewSpec
    Spec holds information about the request being evaluated
    status
    TokenReviewStatus
    Status is filled in by the server and indicates whether the request can be authenticated.
    +

    TokenReviewSpec v1 authentication

    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    audiences
    string array
    Audiences is a list of the identifiers that the resource server presented with the token identifies as. Audience-aware token authenticators will verify that the token was intended for at least one of the audiences in this list. If no audiences are provided, the audience will default to the audience of the Kubernetes apiserver.
    token
    string
    Token is the opaque bearer token.
    +

    TokenReviewStatus v1 authentication

    +
    Appears In: + +
    + + + + + + + + +
    FieldDescription
    audiences
    string array
    Audiences are audience identifiers chosen by the authenticator that are compatible with both the TokenReview and token. An identifier is any identifier in the intersection of the TokenReviewSpec audiences and the token's audiences. A client of the TokenReview API that sets the spec.audiences field should validate that a compatible audience identifier is returned in the status.audiences field to ensure that the TokenReview server is audience aware. If a TokenReview returns an empty status.audience field where status.authenticated is "true", the token is valid against the audience of the Kubernetes API server.
    authenticated
    boolean
    Authenticated indicates that the token was associated with a known user.
    error
    string
    Error indicates that the token couldn't be checked
    user
    UserInfo
    User is the UserInfo associated with the provided token.
    +

    Write Operations

    +

    Create

    +

    create a TokenReview

    +

    HTTP Request

    +POST /apis/authentication.k8s.io/v1/tokenreviews +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    dryRunWhen 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
    fieldManagerfieldManager 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.
    prettyIf 'true', then the output is pretty printed.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    TokenReview
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    TokenReview
    OK
    201
    TokenReview
    Created
    202
    TokenReview
    Accepted
    +

    NetworkPolicy v1 networking.k8s.io

    + + + + + +
    GroupVersionKind
    networking.k8s.iov1NetworkPolicy
    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    spec
    NetworkPolicySpec
    Specification of the desired behavior for this NetworkPolicy.
    +

    NetworkPolicySpec v1 networking

    +
    Appears In: + +
    + + + + + + + + +
    FieldDescription
    egress
    NetworkPolicyEgressRule array
    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
    ingress
    NetworkPolicyIngressRule array
    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)
    podSelector
    LabelSelector
    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 array
    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
    +

    NetworkPolicyList v1 networking

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    NetworkPolicy array
    Items is a list of schema objects.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    +

    Write Operations

    +

    Create

    +

    create a NetworkPolicy

    +

    HTTP Request

    +POST /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    NetworkPolicy
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    NetworkPolicy
    OK
    201
    NetworkPolicy
    Created
    202
    NetworkPolicy
    Accepted
    +

    Patch

    +

    partially update the specified NetworkPolicy

    +

    HTTP Request

    +PATCH /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the NetworkPolicy
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    NetworkPolicy
    OK
    +

    Replace

    +

    replace the specified NetworkPolicy

    +

    HTTP Request

    +PUT /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the NetworkPolicy
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    NetworkPolicy
    +

    Response

    + + + + + + +
    CodeDescription
    200
    NetworkPolicy
    OK
    201
    NetworkPolicy
    Created
    +

    Delete

    +

    delete a NetworkPolicy

    +

    HTTP Request

    +DELETE /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the NetworkPolicy
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of NetworkPolicy

    +

    HTTP Request

    +DELETE /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified NetworkPolicy

    +

    HTTP Request

    +GET /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the NetworkPolicy
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    NetworkPolicy
    OK
    +

    List

    +

    list or watch objects of kind NetworkPolicy

    +

    HTTP Request

    +GET /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    NetworkPolicyList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind NetworkPolicy

    +

    HTTP Request

    +GET /apis/networking.k8s.io/v1/networkpolicies +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    NetworkPolicyList
    OK
    +

    Watch

    +

    watch changes to an object of kind NetworkPolicy. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/networking.k8s.io/v1/watch/namespaces/{namespace}/networkpolicies/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the NetworkPolicy
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of NetworkPolicy. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/networking.k8s.io/v1/watch/namespaces/{namespace}/networkpolicies +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of NetworkPolicy. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/networking.k8s.io/v1/watch/networkpolicies +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    DEFINITIONS

    + +

    This section contains definitions for objects used in the Kubernetes APIs.

    +

    APIGroup v1 meta

    + + + + + +
    GroupVersionKind
    metav1APIGroup
    +

    APIGroup contains the name, the supported versions, and the preferred version of a group.

    +
    Appears In: + +
    + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    name
    string
    name is the name of the group.
    preferredVersion
    GroupVersionForDiscovery
    preferredVersion is the version preferred by the API server, which probably is the storage version.
    serverAddressByClientCIDRs
    ServerAddressByClientCIDR array
    a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.
    versions
    GroupVersionForDiscovery array
    versions are the versions supported in this group.
    +

    APIResource v1 meta

    + + + + + +
    GroupVersionKind
    metav1APIResource
    +

    APIResource specifies the name of a resource and whether it is namespaced.

    +
    Appears In: + +
    + + + + + + + + + + + + + + +
    FieldDescription
    categories
    string array
    categories is a list of the grouped resources this resource belongs to (e.g. 'all')
    group
    string
    group is the preferred group of the resource. Empty implies the group of the containing resource list. For subresources, this may have a different value, for example: Scale".
    kind
    string
    kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')
    name
    string
    name is the plural name of the resource.
    namespaced
    boolean
    namespaced indicates if a resource is namespaced or not.
    shortNames
    string array
    shortNames is a list of suggested short names of the resource.
    singularName
    string
    singularName is the singular name of the resource. This allows clients to handle plural and singular opaquely. The singularName is more correct for reporting status on a single item and both singular and plural are allowed from the kubectl CLI interface.
    storageVersionHash
    string
    The hash value of the storage version, the version this resource is converted to when written to the data store. Value must be treated as opaque by clients. Only equality comparison on the value is valid. This is an alpha feature and may change or be removed in the future. The field is populated by the apiserver only if the StorageVersionHash feature gate is enabled. This field will remain optional even if it graduates.
    verbs
    string array
    verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy)
    version
    string
    version is the preferred version of the resource. Empty implies the version of the containing resource list For subresources, this may have a different value, for example: v1 (while inside a v1beta1 version of the core resource's group)".
    +

    APIServiceCondition v1 apiregistration.k8s.io

    + + + + + +
    GroupVersionKind
    apiregistration.k8s.iov1APIServiceCondition
    +

    APIServiceCondition describes the state of an APIService at a particular point

    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + + + + +
    FieldDescription
    lastTransitionTime
    Time
    Last time the condition transitioned from one status to another.
    message
    string
    Human-readable message indicating details about last transition.
    reason
    string
    Unique, one-word, CamelCase reason for the condition's last transition.
    status
    string
    Status is the status of the condition. Can be True, False, Unknown.
    type
    string
    Type is the type of the condition.
    +

    APIVersions v1 meta

    + + + + + +
    GroupVersionKind
    metav1APIVersions
    +

    APIVersions lists the versions that are available, to allow clients to discover the API at /api, which is the root path of the legacy v1 API.

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    serverAddressByClientCIDRs
    ServerAddressByClientCIDR array
    a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.
    versions
    string array
    versions are the api versions that are available.
    +

    AWSElasticBlockStoreVolumeSource v1 core

    + + + + + +
    GroupVersionKind
    corev1AWSElasticBlockStoreVolumeSource
    +

    Represents a Persistent Disk resource in AWS. + +An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.

    + + + + + + + + + +
    FieldDescription
    fsType
    string
    Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
    partition
    integer
    The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
    readOnly
    boolean
    Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
    volumeID
    string
    Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
    +

    Affinity v1 core

    + + + + + +
    GroupVersionKind
    corev1Affinity
    +

    Affinity is a group of affinity scheduling rules.

    +
    Appears In: + +
    + + + + + + + +
    FieldDescription
    nodeAffinity
    NodeAffinity
    Describes node affinity scheduling rules for the pod.
    podAffinity
    PodAffinity
    Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
    podAntiAffinity
    PodAntiAffinity
    Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
    +

    AggregationRule v1 rbac.authorization.k8s.io

    + + + + + +
    GroupVersionKind
    rbac.authorization.k8s.iov1AggregationRule
    +

    AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole

    +
    Other API versions of this object exist: +v1beta1 +v1alpha1 +
    +
    Appears In: + +
    + + + + + +
    FieldDescription
    clusterRoleSelectors
    LabelSelector array
    ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. If any of the selectors match, then the ClusterRole's permissions will be added
    +

    AllowedCSIDriver v1beta1 policy

    + + + + + +
    GroupVersionKind
    policyv1beta1AllowedCSIDriver
    +

    AllowedCSIDriver represents a single inline CSI Driver that is allowed to be used.

    + + + + + + +
    FieldDescription
    name
    string
    Name is the registered name of the CSI driver
    +

    AllowedFlexVolume v1beta1 policy

    + + + + + +
    GroupVersionKind
    policyv1beta1AllowedFlexVolume
    +

    AllowedFlexVolume represents a single Flexvolume that is allowed to be used.

    + + + + + + +
    FieldDescription
    driver
    string
    driver is the name of the Flexvolume driver.
    +

    AllowedHostPath v1beta1 policy

    + + + + + +
    GroupVersionKind
    policyv1beta1AllowedHostPath
    +

    AllowedHostPath defines the host volume conditions that will be enabled by a policy for pods to use. It requires the path prefix to be defined.

    + + + + + + + +
    FieldDescription
    pathPrefix
    string
    pathPrefix is the path prefix that the host volume must match. It does not support `*`. Trailing slashes are trimmed when validating the path prefix with a host path. Examples: `/foo` would allow `/foo`, `/foo/` and `/foo/bar` `/foo` would not allow `/food` or `/etc/foo`
    readOnly
    boolean
    when set to true, will allow host volumes matching the pathPrefix only if all volume mounts are readOnly.
    +

    AttachedVolume v1 core

    + + + + + +
    GroupVersionKind
    corev1AttachedVolume
    +

    AttachedVolume describes a volume attached to a node

    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    devicePath
    string
    DevicePath represents the device path where the volume should be available
    name
    string
    Name of the attached volume
    +

    AzureDiskVolumeSource v1 core

    + + + + + +
    GroupVersionKind
    corev1AzureDiskVolumeSource
    +

    AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

    + + + + + + + + + + + +
    FieldDescription
    cachingMode
    string
    Host Caching mode: None, Read Only, Read Write.
    diskName
    string
    The Name of the data disk in the blob storage
    diskURI
    string
    The URI the data disk in the blob storage
    fsType
    string
    Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
    kind
    string
    Expected values Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared
    readOnly
    boolean
    Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
    +

    AzureFilePersistentVolumeSource v1 core

    + + + + + +
    GroupVersionKind
    corev1AzureFilePersistentVolumeSource
    +

    AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

    +
    Appears In: + +
    + + + + + + + + +
    FieldDescription
    readOnly
    boolean
    Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
    secretName
    string
    the name of secret that contains Azure Storage Account Name and Key
    secretNamespace
    string
    the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod
    shareName
    string
    Share Name
    +

    AzureFileVolumeSource v1 core

    + + + + + +
    GroupVersionKind
    corev1AzureFileVolumeSource
    +

    AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

    +
    Appears In: + +
    + + + + + + + +
    FieldDescription
    readOnly
    boolean
    Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
    secretName
    string
    the name of secret that contains Azure Storage Account Name and Key
    shareName
    string
    Share Name
    +

    BoundObjectReference v1 authentication.k8s.io

    + + + + + +
    GroupVersionKind
    authentication.k8s.iov1BoundObjectReference
    +

    BoundObjectReference is a reference to an object that a token is bound to.

    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    API version of the referent.
    kind
    string
    Kind of the referent. Valid kinds are 'Pod' and 'Secret'.
    name
    string
    Name of the referent.
    uid
    string
    UID of the referent.
    +

    CSINodeDriver v1 storage.k8s.io

    + + + + + +
    GroupVersionKind
    storage.k8s.iov1CSINodeDriver
    +

    CSINodeDriver holds information about the specification of one CSI driver installed on a node

    +
    Other API versions of this object exist: +v1beta1 +
    +
    Appears In: + +
    + + + + + + + + +
    FieldDescription
    allocatable
    VolumeNodeResources
    allocatable represents the volume resources of a node that are available for scheduling. This field is beta.
    name
    string
    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.
    nodeID
    string
    nodeID of the node from the driver point of view. This field enables Kubernetes to communicate with storage systems that do not share the same nomenclature for nodes. For example, Kubernetes may refer to a given node as "node1", but the storage system may refer to the same node as "nodeA". When Kubernetes issues a command to the storage system to attach a volume to a specific node, it can use this field to refer to the node name using the ID that the storage system will understand, e.g. "nodeA" instead of "node1". This field is required.
    topologyKeys
    string array
    topologyKeys is the list of keys supported by the driver. When a driver is initialized on a cluster, it provides a set of topology keys that it understands (e.g. "company.com/zone", "company.com/region"). When a driver is initialized on a node, it provides the same topology keys along with values. Kubelet will expose these topology keys as labels on its own node object. When Kubernetes does topology aware provisioning, it can use this list to determine which labels it should retrieve from the node object and pass back to the driver. It is possible for different nodes to use different topology keys. This can be empty if driver does not support topology.
    +

    CSIPersistentVolumeSource v1 core

    + + + + + +
    GroupVersionKind
    corev1CSIPersistentVolumeSource
    +

    Represents storage that is managed by an external CSI volume driver (Beta feature)

    +
    Appears In: + +
    + + + + + + + + + + + + + +
    FieldDescription
    controllerExpandSecretRef
    SecretReference
    ControllerExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerExpandVolume call. This is an alpha field and requires enabling ExpandCSIVolumes feature gate. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
    controllerPublishSecretRef
    SecretReference
    ControllerPublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerPublishVolume and ControllerUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
    driver
    string
    Driver is the name of the driver to use for this volume. Required.
    fsType
    string
    Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs".
    nodePublishSecretRef
    SecretReference
    NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
    nodeStageSecretRef
    SecretReference
    NodeStageSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeStageVolume and NodeStageVolume and NodeUnstageVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
    readOnly
    boolean
    Optional: The value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write).
    volumeAttributes
    object
    Attributes of the volume to publish.
    volumeHandle
    string
    VolumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. Required.
    +

    CSIStorageCapacity v1beta1 storage.k8s.io

    + + + + + +
    GroupVersionKind
    storage.k8s.iov1beta1CSIStorageCapacity
    +

    CSIStorageCapacity stores the result of one CSI GetCapacity call. For a given StorageClass, this describes the available capacity in a particular topology segment. This can be used when considering where to instantiate new PersistentVolumes. + +For example this can express things like: - StorageClass "standard" has "1234 GiB" available in "topology.kubernetes.io/zone=us-east1" - StorageClass "localssd" has "10 GiB" available in "kubernetes.io/hostname=knode-abc123" + +The following three cases all imply that no capacity is available for a certain combination: - no object exists with suitable topology and storage class name - such an object exists, but the capacity is unset - such an object exists, but the capacity is zero + +The producer of these objects can decide which approach is more suitable. + +They are consumed by the kube-scheduler if the CSIStorageCapacity beta feature gate is enabled there and a CSI driver opts into capacity-aware scheduling with CSIDriver.StorageCapacity.

    +
    Other API versions of this object exist: +v1alpha1 +
    + + + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    capacity
    Quantity
    Capacity is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields. The semantic is currently (CSI spec 1.2) defined as: The available capacity, in bytes, of the storage that can be used to provision volumes. If not set, that information is currently unavailable and treated like zero capacity.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    maximumVolumeSize
    Quantity
    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.
    metadata
    ObjectMeta
    Standard object's metadata. The name has no particular meaning. It must be be a DNS subdomain (dots allowed, 253 characters). To ensure that there are no conflicts with other CSI drivers on the cluster, the recommendation is to use csisc-<uuid>, a generated name, or a reverse-domain name which ends with the unique CSI driver name. Objects are namespaced. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    nodeTopology
    LabelSelector
    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.
    storageClassName
    string
    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.
    +

    CSIVolumeSource v1 core

    + + + + + +
    GroupVersionKind
    corev1CSIVolumeSource
    +

    Represents a source location of a volume to mount, managed by an external CSI driver

    +
    Appears In: + +
    + + + + + + + + + +
    FieldDescription
    driver
    string
    Driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.
    fsType
    string
    Filesystem type to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.
    nodePublishSecretRef
    LocalObjectReference
    NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.
    readOnly
    boolean
    Specifies a read-only configuration for the volume. Defaults to false (read/write).
    volumeAttributes
    object
    VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.
    +

    Capabilities v1 core

    + + + + + +
    GroupVersionKind
    corev1Capabilities
    +

    Adds and removes POSIX capabilities from running containers.

    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    add
    string array
    Added capabilities
    drop
    string array
    Removed capabilities
    +

    CephFSPersistentVolumeSource v1 core

    + + + + + +
    GroupVersionKind
    corev1CephFSPersistentVolumeSource
    +

    Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.

    +
    Appears In: + +
    + + + + + + + + + + +
    FieldDescription
    monitors
    string array
    Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
    path
    string
    Optional: Used as the mounted root, rather than the full Ceph tree, default is /
    readOnly
    boolean
    Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
    secretFile
    string
    Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
    secretRef
    SecretReference
    Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
    user
    string
    Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
    +

    CephFSVolumeSource v1 core

    + + + + + +
    GroupVersionKind
    corev1CephFSVolumeSource
    +

    Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.

    +
    Appears In: + +
    + + + + + + + + + + +
    FieldDescription
    monitors
    string array
    Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
    path
    string
    Optional: Used as the mounted root, rather than the full Ceph tree, default is /
    readOnly
    boolean
    Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
    secretFile
    string
    Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
    secretRef
    LocalObjectReference
    Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
    user
    string
    Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
    +

    CertificateSigningRequestCondition v1 certificates.k8s.io

    + + + + + +
    GroupVersionKind
    certificates.k8s.iov1CertificateSigningRequestCondition
    +

    CertificateSigningRequestCondition describes a condition of a CertificateSigningRequest object

    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + + + + + +
    FieldDescription
    lastTransitionTime
    Time
    lastTransitionTime is the time the condition last transitioned from one status to another. If unset, when a new condition type is added or an existing condition's status is changed, the server defaults this to the current time.
    lastUpdateTime
    Time
    lastUpdateTime is the time of the last update to this condition
    message
    string
    message contains a human readable message with details about the request state
    reason
    string
    reason indicates a brief reason for the request state
    status
    string
    status of the condition, one of True, False, Unknown. Approved, Denied, and Failed conditions may not be "False" or "Unknown".
    type
    string
    type of the condition. Known conditions are "Approved", "Denied", and "Failed". An "Approved" condition is added via the /approval subresource, indicating the request was approved and should be issued by the signer. A "Denied" condition is added via the /approval subresource, indicating the request was denied and should not be issued by the signer. A "Failed" condition is added via the /status subresource, indicating the signer failed to issue the certificate. Approved and Denied conditions are mutually exclusive. Approved, Denied, and Failed conditions cannot be removed once added. Only one condition of a given type is allowed.
    +

    CinderPersistentVolumeSource v1 core

    + + + + + +
    GroupVersionKind
    corev1CinderPersistentVolumeSource
    +

    Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.

    +
    Appears In: + +
    + + + + + + + + +
    FieldDescription
    fsType
    string
    Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
    readOnly
    boolean
    Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
    secretRef
    SecretReference
    Optional: points to a secret object containing parameters used to connect to OpenStack.
    volumeID
    string
    volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
    +

    CinderVolumeSource v1 core

    + + + + + +
    GroupVersionKind
    corev1CinderVolumeSource
    +

    Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.

    +
    Appears In: + +
    + + + + + + + + +
    FieldDescription
    fsType
    string
    Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
    readOnly
    boolean
    Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
    secretRef
    LocalObjectReference
    Optional: points to a secret object containing parameters used to connect to OpenStack.
    volumeID
    string
    volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
    +

    ClientIPConfig v1 core

    + + + + + +
    GroupVersionKind
    corev1ClientIPConfig
    +

    ClientIPConfig represents the configurations of Client IP based session affinity.

    +
    Appears In: + +
    + + + + + +
    FieldDescription
    timeoutSeconds
    integer
    timeoutSeconds specifies the seconds of ClientIP type session sticky time. The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP". Default value is 10800(for 3 hours).
    +

    ComponentCondition v1 core

    + + + + + +
    GroupVersionKind
    corev1ComponentCondition
    +

    Information about the condition of a component.

    +
    Appears In: + +
    + + + + + + + + +
    FieldDescription
    error
    string
    Condition error code for a component. For example, a health check error code.
    message
    string
    Message about the condition for a component. For example, information about a health check.
    status
    string
    Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown".
    type
    string
    Type of condition for a component. Valid value: "Healthy"
    +

    Condition v1 meta

    + + + + + +
    GroupVersionKind
    metav1Condition
    +

    Condition contains details for one aspect of the current state of this API Resource.

    + + + + + + + + + + + +
    FieldDescription
    lastTransitionTime
    Time
    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.
    message
    string
    message is a human readable message indicating details about the transition. This may be an empty string.
    observedGeneration
    integer
    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.
    reason
    string
    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
    string
    status of the condition, one of True, False, Unknown.
    type
    string
    type of condition in CamelCase or in foo.example.com/CamelCase.
    +

    ConfigMapEnvSource v1 core

    + + + + + +
    GroupVersionKind
    corev1ConfigMapEnvSource
    +

    ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. + +The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.

    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    name
    string
    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
    optional
    boolean
    Specify whether the ConfigMap must be defined
    +

    ConfigMapKeySelector v1 core

    + + + + + +
    GroupVersionKind
    corev1ConfigMapKeySelector
    +

    Selects a key from a ConfigMap.

    +
    Appears In: + +
    + + + + + + + +
    FieldDescription
    key
    string
    The key to select.
    name
    string
    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
    optional
    boolean
    Specify whether the ConfigMap or its key must be defined
    +

    ConfigMapNodeConfigSource v1 core

    + + + + + +
    GroupVersionKind
    corev1ConfigMapNodeConfigSource
    +

    ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node.

    +
    Appears In: + +
    + + + + + + + + + +
    FieldDescription
    kubeletConfigKey
    string
    KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.
    name
    string
    Name is the metadata.name of the referenced ConfigMap. This field is required in all cases.
    namespace
    string
    Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.
    resourceVersion
    string
    ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.
    uid
    string
    UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.
    +

    ConfigMapProjection v1 core

    + + + + + +
    GroupVersionKind
    corev1ConfigMapProjection
    +

    Adapts a ConfigMap into a projected volume. + +The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode.

    +
    Appears In: + +
    + + + + + + + +
    FieldDescription
    items
    KeyToPath array
    If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
    name
    string
    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
    optional
    boolean
    Specify whether the ConfigMap or its keys must be defined
    +

    ConfigMapVolumeSource v1 core

    + + + + + +
    GroupVersionKind
    corev1ConfigMapVolumeSource
    +

    Adapts a ConfigMap into a volume. + +The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.

    +
    Appears In: + +
    + + + + + + + + +
    FieldDescription
    defaultMode
    integer
    Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
    items
    KeyToPath array
    If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
    name
    string
    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
    optional
    boolean
    Specify whether the ConfigMap or its keys must be defined
    +

    ContainerImage v1 core

    + + + + + +
    GroupVersionKind
    corev1ContainerImage
    +

    Describe a container image

    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    names
    string array
    Names by which this image is known. e.g. ["k8s.gcr.io/hyperkube:v1.0.7", "dockerhub.io/google_containers/hyperkube:v1.0.7"]
    sizeBytes
    integer
    The size of the image in bytes.
    +

    ContainerPort v1 core

    + + + + + +
    GroupVersionKind
    corev1ContainerPort
    +

    ContainerPort represents a network port in a single container.

    + + + + + + + + + + +
    FieldDescription
    containerPort
    integer
    Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
    hostIP
    string
    What host IP to bind the external port to.
    hostPort
    integer
    Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.
    name
    string
    If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.
    protocol
    string
    Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".
    +

    ContainerResourceMetricSource v2beta2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta2ContainerResourceMetricSource
    +

    ContainerResourceMetricSource indicates how to scale on a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). The values will be averaged together before being compared to the target. Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. Only one "target" type should be set.

    +
    Other API versions of this object exist: +v2beta1 +
    + + + + + + + + +
    FieldDescription
    container
    string
    container is the name of the container in the pods of the scaling target
    name
    string
    name is the name of the resource in question.
    target
    MetricTarget
    target specifies the target value for the given metric
    +

    ContainerResourceMetricStatus v2beta2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta2ContainerResourceMetricStatus
    +

    ContainerResourceMetricStatus indicates the current value of a resource metric known to Kubernetes, as specified in requests and limits, describing a single container in each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.

    +
    Other API versions of this object exist: +v2beta1 +
    + + + + + + + + +
    FieldDescription
    container
    string
    Container is the name of the container in the pods of the scaling target
    current
    MetricValueStatus
    current contains the current value for the given metric
    name
    string
    Name is the name of the resource in question.
    +

    ContainerState v1 core

    + + + + + +
    GroupVersionKind
    corev1ContainerState
    +

    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.

    +
    Appears In: + +
    + + + + + + + +
    FieldDescription
    running
    ContainerStateRunning
    Details about a running container
    terminated
    ContainerStateTerminated
    Details about a terminated container
    waiting
    ContainerStateWaiting
    Details about a waiting container
    +

    ContainerStateRunning v1 core

    + + + + + +
    GroupVersionKind
    corev1ContainerStateRunning
    +

    ContainerStateRunning is a running state of a container.

    +
    Appears In: + +
    + + + + + +
    FieldDescription
    startedAt
    Time
    Time at which the container was last (re-)started
    +

    ContainerStateTerminated v1 core

    + + + + + +
    GroupVersionKind
    corev1ContainerStateTerminated
    +

    ContainerStateTerminated is a terminated state of a container.

    +
    Appears In: + +
    + + + + + + + + + + + +
    FieldDescription
    containerID
    string
    Container's ID in the format 'docker://<container_id>'
    exitCode
    integer
    Exit status from the last termination of the container
    finishedAt
    Time
    Time at which the container last terminated
    message
    string
    Message regarding the last termination of the container
    reason
    string
    (brief) reason from the last termination of the container
    signal
    integer
    Signal from the last termination of the container
    startedAt
    Time
    Time at which previous execution of the container started
    +

    ContainerStateWaiting v1 core

    + + + + + +
    GroupVersionKind
    corev1ContainerStateWaiting
    +

    ContainerStateWaiting is a waiting state of a container.

    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    message
    string
    Message regarding why the container is not yet running.
    reason
    string
    (brief) reason the container is not yet running.
    +

    CronJob v1 batch

    + + + + + +
    GroupVersionKind
    batchv1CronJob
    +

    CronJob represents the configuration of a single cron job.

    +
    Other API versions of this object exist: +v1beta1 +
    +
    Appears In: + +
    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    spec
    CronJobSpec
    Specification of the desired behavior of a cron job, including the schedule. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    status
    CronJobStatus
    Current status of a cron job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    +

    CrossVersionObjectReference v1 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv1CrossVersionObjectReference
    +

    CrossVersionObjectReference contains enough information to let you identify the referred resource.

    +
    Other API versions of this object exist: +v2beta2 +v2beta1 +
    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    API version of the referent
    kind
    string
    Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"
    name
    string
    Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
    +

    CustomResourceColumnDefinition v1 apiextensions.k8s.io

    + + + + + +
    GroupVersionKind
    apiextensions.k8s.iov1CustomResourceColumnDefinition
    +

    CustomResourceColumnDefinition specifies a column for server side printing.

    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + + + + + +
    FieldDescription
    description
    string
    description is a human readable description of this column.
    format
    string
    format is an optional OpenAPI type definition for this column. The 'name' format is applied to the primary identifier column to assist in clients identifying column is the resource name. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details.
    jsonPath
    string
    jsonPath is a simple JSON path (i.e. with array notation) which is evaluated against each custom resource to produce the value for this column.
    name
    string
    name is a human readable name for the column.
    priority
    integer
    priority is an integer defining the relative importance of this column compared to others. Lower numbers are considered higher priority. Columns that may be omitted in limited space scenarios should be given a priority greater than 0.
    type
    string
    type is an OpenAPI type definition for this column. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details.
    +

    CustomResourceConversion v1 apiextensions.k8s.io

    + + + + + +
    GroupVersionKind
    apiextensions.k8s.iov1CustomResourceConversion
    +

    CustomResourceConversion describes how to convert different versions of a CR.

    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + +
    FieldDescription
    strategy
    string
    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.
    webhook
    WebhookConversion
    webhook describes how to call the conversion webhook. Required when `strategy` is set to `Webhook`.
    +

    CustomResourceDefinitionCondition v1 apiextensions.k8s.io

    + + + + + +
    GroupVersionKind
    apiextensions.k8s.iov1CustomResourceDefinitionCondition
    +

    CustomResourceDefinitionCondition contains details for the current condition of this pod.

    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + + + + +
    FieldDescription
    lastTransitionTime
    Time
    lastTransitionTime last time the condition transitioned from one status to another.
    message
    string
    message is a human-readable message indicating details about last transition.
    reason
    string
    reason is a unique, one-word, CamelCase reason for the condition's last transition.
    status
    string
    status is the status of the condition. Can be True, False, Unknown.
    type
    string
    type is the type of the condition. Types include Established, NamesAccepted and Terminating.
    +

    CustomResourceDefinitionNames v1 apiextensions.k8s.io

    + + + + + +
    GroupVersionKind
    apiextensions.k8s.iov1CustomResourceDefinitionNames
    +

    CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition

    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + + + + + +
    FieldDescription
    categories
    string array
    categories is a list of grouped resources this custom resource belongs to (e.g. 'all'). This is published in API discovery documents, and used by clients to support invocations like `kubectl get all`.
    kind
    string
    kind is the serialized kind of the resource. It is normally CamelCase and singular. Custom resource instances will use this value as the `kind` attribute in API calls.
    listKind
    string
    listKind is the serialized kind of the list for this resource. Defaults to "`kind`List".
    plural
    string
    plural is the plural name of the resource to serve. The custom resources are served under `/apis/<group>/<version>/.../<plural>`. Must match the name of the CustomResourceDefinition (in the form `<names.plural>.<group>`). Must be all lowercase.
    shortNames
    string array
    shortNames are short names for the resource, exposed in API discovery documents, and used by clients to support invocations like `kubectl get <shortname>`. It must be all lowercase.
    singular
    string
    singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased `kind`.
    +

    CustomResourceDefinitionVersion v1 apiextensions.k8s.io

    + + + + + +
    GroupVersionKind
    apiextensions.k8s.iov1CustomResourceDefinitionVersion
    +

    CustomResourceDefinitionVersion describes a version for CRD.

    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + + + + + + + +
    FieldDescription
    additionalPrinterColumns
    CustomResourceColumnDefinition array
    additionalPrinterColumns specifies additional columns returned in Table output. See https://kubernetes.io/docs/reference/using-api/api-concepts/#receiving-resources-as-tables for details. If no columns are specified, a single column displaying the age of the custom resource is used.
    deprecated
    boolean
    deprecated indicates this version of the custom resource API is deprecated. When set to true, API requests to this version receive a warning header in the server response. Defaults to false.
    deprecationWarning
    string
    deprecationWarning overrides the default warning returned to API clients. May only be set when `deprecated` is true. The default warning indicates this version is deprecated and recommends use of the newest served version of equal or greater stability, if one exists.
    name
    string
    name is the version name, e.g. “v1”, “v2beta1”, etc. The custom resources are served under this version at `/apis/<group>/<version>/...` if `served` is true.
    schema
    CustomResourceValidation
    schema describes the schema used for validation, pruning, and defaulting of this version of the custom resource.
    served
    boolean
    served is a flag enabling/disabling this version from being served via REST APIs
    storage
    boolean
    storage indicates this version should be used when persisting custom resources to storage. There must be exactly one version with storage=true.
    subresources
    CustomResourceSubresources
    subresources specify what subresources this version of the defined custom resource have.
    +

    CustomResourceSubresourceScale v1 apiextensions.k8s.io

    + + + + + +
    GroupVersionKind
    apiextensions.k8s.iov1CustomResourceSubresourceScale
    +

    CustomResourceSubresourceScale defines how to serve the scale subresource for CustomResources.

    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + + +
    FieldDescription
    labelSelectorPath
    string
    labelSelectorPath defines the JSON path inside of a custom resource that corresponds to Scale `status.selector`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.status` or `.spec`. Must be set to work with HorizontalPodAutoscaler. The field pointed by this JSON path must be a string field (not a complex selector struct) which contains a serialized label selector in string form. More info: https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions#scale-subresource If there is no value under the given path in the custom resource, the `status.selector` value in the `/scale` subresource will default to the empty string.
    specReplicasPath
    string
    specReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale `spec.replicas`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.spec`. If there is no value under the given path in the custom resource, the `/scale` subresource will return an error on GET.
    statusReplicasPath
    string
    statusReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale `status.replicas`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.status`. If there is no value under the given path in the custom resource, the `status.replicas` value in the `/scale` subresource will default to 0.
    +

    CustomResourceSubresourceStatus v1 apiextensions.k8s.io

    + + + + + +
    GroupVersionKind
    apiextensions.k8s.iov1CustomResourceSubresourceStatus
    +

    CustomResourceSubresourceStatus defines how to serve the status subresource for CustomResources. Status is represented by the `.status` JSON path inside of a CustomResource. When set, * exposes a /status subresource for the custom resource * PUT requests to the /status subresource take a custom resource object, and ignore changes to anything except the status stanza * PUT/POST/PATCH requests to the custom resource ignore changes to the status stanza

    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + +
    FieldDescription
    +

    CustomResourceSubresources v1 apiextensions.k8s.io

    + + + + + +
    GroupVersionKind
    apiextensions.k8s.iov1CustomResourceSubresources
    +

    CustomResourceSubresources defines the status and scale subresources for CustomResources.

    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + +
    FieldDescription
    scale
    CustomResourceSubresourceScale
    scale indicates the custom resource should serve a `/scale` subresource that returns an `autoscaling/v1` Scale object.
    status
    CustomResourceSubresourceStatus
    status indicates the custom resource should serve a `/status` subresource. When enabled: 1. requests to the custom resource primary endpoint ignore changes to the `status` stanza of the object. 2. requests to the custom resource `/status` subresource ignore changes to anything other than the `status` stanza of the object.
    +

    CustomResourceValidation v1 apiextensions.k8s.io

    + + + + + +
    GroupVersionKind
    apiextensions.k8s.iov1CustomResourceValidation
    +

    CustomResourceValidation is a list of validation methods for CustomResources.

    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + +
    FieldDescription
    openAPIV3Schema
    JSONSchemaProps
    openAPIV3Schema is the OpenAPI v3 schema to use for validation and pruning.
    +

    DaemonEndpoint v1 core

    + + + + + +
    GroupVersionKind
    corev1DaemonEndpoint
    +

    DaemonEndpoint contains information about a single Daemon endpoint.

    +
    Appears In: + +
    + + + + + +
    FieldDescription
    Port
    integer
    Port number of the given endpoint.
    +

    DaemonSetCondition v1 apps

    + + + + + +
    GroupVersionKind
    appsv1DaemonSetCondition
    +

    DaemonSetCondition describes the state of a DaemonSet at a certain point.

    +
    Appears In: + +
    + + + + + + + + + +
    FieldDescription
    lastTransitionTime
    Time
    Last time the condition transitioned from one status to another.
    message
    string
    A human readable message indicating details about the transition.
    reason
    string
    The reason for the condition's last transition.
    status
    string
    Status of the condition, one of True, False, Unknown.
    type
    string
    Type of DaemonSet condition.
    +

    DaemonSetUpdateStrategy v1 apps

    + + + + + +
    GroupVersionKind
    appsv1DaemonSetUpdateStrategy
    +

    DaemonSetUpdateStrategy is a struct used to control the update strategy for a DaemonSet.

    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    rollingUpdate
    RollingUpdateDaemonSet
    Rolling update config params. Present only if type = "RollingUpdate".
    type
    string
    Type of daemon set update. Can be "RollingUpdate" or "OnDelete". Default is RollingUpdate.
    +

    DeleteOptions v1 meta

    + + + + + +
    GroupVersionKind
    metav1DeleteOptions
    +

    DeleteOptions may be provided when deleting an API object.

    +
    Appears In: + +
    + + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    dryRun
    string array
    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
    gracePeriodSeconds
    integer
    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.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    orphanDependents
    boolean
    Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    preconditions
    Preconditions
    Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.
    propagationPolicy
    string
    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.
    +

    DeploymentCondition v1 apps

    + + + + + +
    GroupVersionKind
    appsv1DeploymentCondition
    +

    DeploymentCondition describes the state of a deployment at a certain point.

    +
    Appears In: + +
    + + + + + + + + + + +
    FieldDescription
    lastTransitionTime
    Time
    Last time the condition transitioned from one status to another.
    lastUpdateTime
    Time
    The last time this condition was updated.
    message
    string
    A human readable message indicating details about the transition.
    reason
    string
    The reason for the condition's last transition.
    status
    string
    Status of the condition, one of True, False, Unknown.
    type
    string
    Type of deployment condition.
    +

    DownwardAPIProjection v1 core

    + + + + + +
    GroupVersionKind
    corev1DownwardAPIProjection
    +

    Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode.

    +
    Appears In: + +
    + + + + + +
    FieldDescription
    items
    DownwardAPIVolumeFile array
    Items is a list of DownwardAPIVolume file
    +

    DownwardAPIVolumeFile v1 core

    + + + + + +
    GroupVersionKind
    corev1DownwardAPIVolumeFile
    +

    DownwardAPIVolumeFile represents information to create the file containing the pod field

    + + + + + + + + + +
    FieldDescription
    fieldRef
    ObjectFieldSelector
    Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
    mode
    integer
    Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
    path
    string
    Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'
    resourceFieldRef
    ResourceFieldSelector
    Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
    +

    DownwardAPIVolumeSource v1 core

    + + + + + +
    GroupVersionKind
    corev1DownwardAPIVolumeSource
    +

    DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.

    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    defaultMode
    integer
    Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
    items
    DownwardAPIVolumeFile array
    Items is a list of downward API volume file
    +

    EmptyDirVolumeSource v1 core

    + + + + + +
    GroupVersionKind
    corev1EmptyDirVolumeSource
    +

    Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.

    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    medium
    string
    What type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
    sizeLimit
    Quantity
    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
    +

    Endpoint v1 discovery.k8s.io

    + + + + + +
    GroupVersionKind
    discovery.k8s.iov1Endpoint
    +

    Endpoint represents a single logical "backend" implementing a service.

    +
    Other API versions of this object exist: +v1beta1 +
    +
    Appears In: + +
    + + + + + + + + + + + + +
    FieldDescription
    addresses
    string array
    addresses of this endpoint. The contents of this field are interpreted according to the corresponding EndpointSlice addressType field. Consumers must handle different types of addresses in the context of their own capabilities. This must contain at least one address but no more than 100.
    conditions
    EndpointConditions
    conditions contains information about the current status of the endpoint.
    deprecatedTopology
    object
    deprecatedTopology contains topology information part of the v1beta1 API. This field is deprecated, and will be removed when the v1beta1 API is removed (no sooner than kubernetes v1.24). While this field can hold values, it is not writable through the v1 API, and any attempts to write to it will be silently ignored. Topology information can be found in the zone and nodeName fields instead.
    hints
    EndpointHints
    hints contains information associated with how an endpoint should be consumed.
    hostname
    string
    hostname of this endpoint. This field may be used by consumers of endpoints to distinguish endpoints from each other (e.g. in DNS names). Multiple endpoints which use the same hostname should be considered fungible (e.g. multiple A values in DNS). Must be lowercase and pass DNS Label (RFC 1123) validation.
    nodeName
    string
    nodeName represents the name of the Node hosting this endpoint. This can be used to determine endpoints local to a Node. This field can be enabled with the EndpointSliceNodeName feature gate.
    targetRef
    ObjectReference
    targetRef is a reference to a Kubernetes object that represents this endpoint.
    zone
    string
    zone is the name of the Zone this endpoint exists in.
    +

    EndpointAddress v1 core

    + + + + + +
    GroupVersionKind
    corev1EndpointAddress
    +

    EndpointAddress is a tuple that describes single IP address.

    +
    Appears In: + +
    + + + + + + + + +
    FieldDescription
    hostname
    string
    The Hostname of this endpoint
    ip
    string
    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.
    nodeName
    string
    Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node.
    targetRef
    ObjectReference
    Reference to object providing the endpoint.
    +

    EndpointConditions v1 discovery.k8s.io

    + + + + + +
    GroupVersionKind
    discovery.k8s.iov1EndpointConditions
    +

    EndpointConditions represents the current condition of an endpoint.

    +
    Other API versions of this object exist: +v1beta1 +
    +
    Appears In: + +
    + + + + + + + +
    FieldDescription
    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.
    serving
    boolean
    serving is identical to ready except that it is set regardless of the terminating state of endpoints. This condition should be set to true for a ready endpoint that is terminating. If nil, consumers should defer to the ready condition. This field can be enabled with the EndpointSliceTerminatingCondition feature gate.
    terminating
    boolean
    terminating indicates that this endpoint is terminating. A nil value indicates an unknown state. Consumers should interpret this unknown state to mean that the endpoint is not terminating. This field can be enabled with the EndpointSliceTerminatingCondition feature gate.
    +

    EndpointHints v1 discovery.k8s.io

    + + + + + +
    GroupVersionKind
    discovery.k8s.iov1EndpointHints
    +

    EndpointHints provides hints describing how an endpoint should be consumed.

    +
    Other API versions of this object exist: +v1beta1 +
    +
    Appears In: + +
    + + + + + +
    FieldDescription
    forZones
    ForZone array
    forZones indicates the zone(s) this endpoint should be consumed by to enable topology aware routing.
    +

    EndpointPort v1 core

    + + + + + +
    GroupVersionKind
    corev1EndpointPort
    +

    EndpointPort is a tuple that describes a single port.

    +
    Other API versions of this object exist: +v1beta1 +
    +
    Appears In: + +
    + + + + + + + + +
    FieldDescription
    appProtocol
    string
    The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol. This is a beta field that is guarded by the ServiceAppProtocol feature gate and enabled by default.
    name
    string
    The name of this port. This must match the 'name' field in the corresponding ServicePort. Must be a DNS_LABEL. Optional only if one port is defined.
    port
    integer
    The port number of the endpoint.
    protocol
    string
    The IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP.
    +

    EndpointSlice v1 discovery.k8s.io

    + + + + + +
    GroupVersionKind
    discovery.k8s.iov1EndpointSlice
    +

    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.

    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + + + + + +
    FieldDescription
    addressType
    string
    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.
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    endpoints
    Endpoint array
    endpoints is a list of unique endpoints in this slice. Each slice may include a maximum of 1000 endpoints.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata.
    ports
    EndpointPort array
    ports specifies the list of network ports exposed by each endpoint in this slice. Each port must have a unique name. When ports is empty, it indicates that there are no defined ports. When a port is defined with a nil port value, it indicates "all ports". Each slice may include a maximum of 100 ports.
    +

    EndpointSubset v1 core

    + + + + + +
    GroupVersionKind
    corev1EndpointSubset
    +

    EndpointSubset is a group of addresses with a common set of ports. The expanded set of endpoints is the Cartesian product of Addresses x Ports. For example, given: + { + Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], + Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] + } +The resulting set of endpoints can be viewed as: + a: [ 10.10.1.1:8675, 10.10.2.2:8675 ], + b: [ 10.10.1.1:309, 10.10.2.2:309 ]

    +
    Appears In: + +
    + + + + + + + +
    FieldDescription
    addresses
    EndpointAddress array
    IP addresses which offer the related ports that are marked as ready. These endpoints should be considered safe for load balancers and clients to utilize.
    notReadyAddresses
    EndpointAddress array
    IP addresses which offer the related ports but are not currently marked as ready because they have not yet finished starting, have recently failed a readiness check, or have recently failed a liveness check.
    ports
    EndpointPort array
    Port numbers available on the related IP addresses.
    +

    EnvFromSource v1 core

    + + + + + +
    GroupVersionKind
    corev1EnvFromSource
    +

    EnvFromSource represents the source of a set of ConfigMaps

    + + + + + + + + +
    FieldDescription
    configMapRef
    ConfigMapEnvSource
    The ConfigMap to select from
    prefix
    string
    An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
    secretRef
    SecretEnvSource
    The Secret to select from
    +

    EnvVar v1 core

    + + + + + +
    GroupVersionKind
    corev1EnvVar
    +

    EnvVar represents an environment variable present in a Container.

    + + + + + + + + +
    FieldDescription
    name
    string
    Name of the environment variable. Must be a C_IDENTIFIER.
    value
    string
    Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".
    valueFrom
    EnvVarSource
    Source for the environment variable's value. Cannot be used if value is not empty.
    +

    EnvVarSource v1 core

    + + + + + +
    GroupVersionKind
    corev1EnvVarSource
    +

    EnvVarSource represents a source for the value of an EnvVar.

    +
    Appears In: + +
    + + + + + + + + +
    FieldDescription
    configMapKeyRef
    ConfigMapKeySelector
    Selects a key of a ConfigMap.
    fieldRef
    ObjectFieldSelector
    Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
    resourceFieldRef
    ResourceFieldSelector
    Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
    secretKeyRef
    SecretKeySelector
    Selects a key of a secret in the pod's namespace
    +

    EphemeralContainer v1 core

    + + + + + +
    GroupVersionKind
    corev1EphemeralContainer
    +

    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.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    args
    string array
    Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
    command
    string array
    Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
    env
    EnvVar array
    patch strategy: merge
    patch merge key: name
    List of environment variables to set in the container. Cannot be updated.
    envFrom
    EnvFromSource array
    List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
    image
    string
    Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images
    imagePullPolicy
    string
    Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
    lifecycle
    Lifecycle
    Lifecycle is not allowed for ephemeral containers.
    livenessProbe
    Probe
    Probes are not allowed for ephemeral containers.
    name
    string
    Name of the ephemeral container specified as a DNS_LABEL. This name must be unique among all containers, init containers and ephemeral containers.
    ports
    ContainerPort array
    Ports are not allowed for ephemeral containers.
    readinessProbe
    Probe
    Probes are not allowed for ephemeral containers.
    resources
    ResourceRequirements
    Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod.
    securityContext
    SecurityContext
    SecurityContext is not allowed for ephemeral containers.
    startupProbe
    Probe
    Probes are not allowed for ephemeral containers.
    stdin
    boolean
    Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.
    stdinOnce
    boolean
    Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false
    targetContainerName
    string
    If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container is run in whatever namespaces are shared for the pod. Note that the container runtime must support this feature.
    terminationMessagePath
    string
    Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.
    terminationMessagePolicy
    string
    Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
    tty
    boolean
    Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
    volumeDevices
    VolumeDevice array
    patch strategy: merge
    patch merge key: devicePath
    volumeDevices is the list of block devices to be used by the container.
    volumeMounts
    VolumeMount array
    patch strategy: merge
    patch merge key: mountPath
    Pod volumes to mount into the container's filesystem. Cannot be updated.
    workingDir
    string
    Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.
    +

    EphemeralContainers v1 core

    + + + + + +
    GroupVersionKind
    corev1EphemeralContainers
    +

    A list of ephemeral containers used with the Pod ephemeralcontainers subresource.

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    ephemeralContainers
    EphemeralContainer array
    patch strategy: merge
    patch merge key: name
    A list of ephemeral containers associated with this pod. New ephemeral containers may be appended to this list, but existing ephemeral containers may not be removed or modified.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    +

    EphemeralVolumeSource v1 core

    + + + + + +
    GroupVersionKind
    corev1EphemeralVolumeSource
    +

    Represents an ephemeral volume that is handled by a normal storage driver.

    +
    Appears In: + +
    + + + + + +
    FieldDescription
    volumeClaimTemplate
    PersistentVolumeClaimTemplate
    Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `<pod name>-<volume name>` where `<volume name>` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). An existing PVC with that name that is not owned by the pod will *not* be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. Required, must not be nil.
    +

    EventSeries v1 core

    + + + + + +
    GroupVersionKind
    corev1EventSeries
    +

    EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time.

    +
    Other API versions of this object exist: +v1beta1 +
    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    count
    integer
    Number of occurrences in this series up to the last heartbeat time
    lastObservedTime
    MicroTime
    Time of the last occurrence observed
    +

    EventSource v1 core

    + + + + + +
    GroupVersionKind
    corev1EventSource
    +

    EventSource contains information for an event.

    + + + + + + + +
    FieldDescription
    component
    string
    Component from which the event is generated.
    host
    string
    Node name on which the event is generated.
    +

    Eviction v1beta1 policy

    + + + + + +
    GroupVersionKind
    policyv1beta1Eviction
    +

    Eviction evicts a pod from its node subject to certain policies and safety constraints. This is a subresource of Pod. A request to cause such an eviction is created by POSTing to .../pods/<pod name>/evictions.

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    deleteOptions
    DeleteOptions
    DeleteOptions may be provided
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    ObjectMeta describes the pod that is being evicted.
    +

    ExecAction v1 core

    + + + + + +
    GroupVersionKind
    corev1ExecAction
    +

    ExecAction describes a "run in container" action.

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

    ExternalDocumentation v1 apiextensions.k8s.io

    + + + + + +
    GroupVersionKind
    apiextensions.k8s.iov1ExternalDocumentation
    +

    ExternalDocumentation allows referencing an external resource for extended documentation.

    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + +
    FieldDescription
    description
    string
    url
    string
    +

    ExternalMetricSource v2beta2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta2ExternalMetricSource
    +

    ExternalMetricSource indicates how to scale on a metric not associated with any Kubernetes object (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster).

    +
    Other API versions of this object exist: +v2beta1 +
    + + + + + + + +
    FieldDescription
    metric
    MetricIdentifier
    metric identifies the target metric by name and selector
    target
    MetricTarget
    target specifies the target value for the given metric
    +

    ExternalMetricStatus v2beta2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta2ExternalMetricStatus
    +

    ExternalMetricStatus indicates the current value of a global metric not associated with any Kubernetes object.

    +
    Other API versions of this object exist: +v2beta1 +
    + + + + + + + +
    FieldDescription
    current
    MetricValueStatus
    current contains the current value for the given metric
    metric
    MetricIdentifier
    metric identifies the target metric by name and selector
    +

    FCVolumeSource v1 core

    + + + + + +
    GroupVersionKind
    corev1FCVolumeSource
    +

    Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.

    + + + + + + + + + + +
    FieldDescription
    fsType
    string
    Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
    lun
    integer
    Optional: FC target lun number
    readOnly
    boolean
    Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
    targetWWNs
    string array
    Optional: FC target worldwide names (WWNs)
    wwids
    string array
    Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
    +

    FSGroupStrategyOptions v1beta1 policy

    + + + + + +
    GroupVersionKind
    policyv1beta1FSGroupStrategyOptions
    +

    FSGroupStrategyOptions defines the strategy type and options used to create the strategy.

    + + + + + + + +
    FieldDescription
    ranges
    IDRange array
    ranges are the allowed ranges of fs groups. If you would like to force a single fs group then supply a single range with the same start and end. Required for MustRunAs.
    rule
    string
    rule is the strategy that will dictate what FSGroup is used in the SecurityContext.
    +

    FieldsV1 v1 meta

    + + + + + +
    GroupVersionKind
    metav1FieldsV1
    +

    FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format. + +Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:<name>', where <name> is the name of a field in a struct, or key in a map 'v:<value>', where <value> is the exact json formatted value of a list item 'i:<index>', where <index> is position of a item in a list 'k:<keys>', where <keys> is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set. + +The exact format is defined in sigs.k8s.io/structured-merge-diff

    +
    Appears In: + +
    + + + + +
    FieldDescription
    +

    FlexPersistentVolumeSource v1 core

    + + + + + +
    GroupVersionKind
    corev1FlexPersistentVolumeSource
    +

    FlexPersistentVolumeSource represents a generic persistent volume resource that is provisioned/attached using an exec based plugin.

    +
    Appears In: + +
    + + + + + + + + + +
    FieldDescription
    driver
    string
    Driver is the name of the driver to use for this volume.
    fsType
    string
    Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
    options
    object
    Optional: Extra command options if any.
    readOnly
    boolean
    Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
    secretRef
    SecretReference
    Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.
    +

    FlexVolumeSource v1 core

    + + + + + +
    GroupVersionKind
    corev1FlexVolumeSource
    +

    FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

    +
    Appears In: + +
    + + + + + + + + + +
    FieldDescription
    driver
    string
    Driver is the name of the driver to use for this volume.
    fsType
    string
    Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
    options
    object
    Optional: Extra command options if any.
    readOnly
    boolean
    Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
    secretRef
    LocalObjectReference
    Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.
    +

    FlockerVolumeSource v1 core

    + + + + + +
    GroupVersionKind
    corev1FlockerVolumeSource
    +

    Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.

    + + + + + + + +
    FieldDescription
    datasetName
    string
    Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
    datasetUUID
    string
    UUID of the dataset. This is unique identifier of a Flocker dataset
    +

    FlowDistinguisherMethod v1beta1 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta1FlowDistinguisherMethod
    +

    FlowDistinguisherMethod specifies the method of a flow distinguisher.

    + + + + + + +
    FieldDescription
    type
    string
    `type` is the type of flow distinguisher method The supported types are "ByUser" and "ByNamespace". Required.
    +

    FlowSchemaCondition v1beta1 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta1FlowSchemaCondition
    +

    FlowSchemaCondition describes conditions for a FlowSchema.

    + + + + + + + + + + +
    FieldDescription
    lastTransitionTime
    Time
    `lastTransitionTime` is the last time the condition transitioned from one status to another.
    message
    string
    `message` is a human-readable message indicating details about last transition.
    reason
    string
    `reason` is a unique, one-word, CamelCase reason for the condition's last transition.
    status
    string
    `status` is the status of the condition. Can be True, False, Unknown. Required.
    type
    string
    `type` is the type of the condition. Required.
    +

    ForZone v1 discovery.k8s.io

    + + + + + +
    GroupVersionKind
    discovery.k8s.iov1ForZone
    +

    ForZone provides information about which zones should consume this endpoint.

    +
    Other API versions of this object exist: +v1beta1 +
    +
    Appears In: + +
    + + + + + +
    FieldDescription
    name
    string
    name represents the name of the zone.
    +

    GCEPersistentDiskVolumeSource v1 core

    + + + + + +
    GroupVersionKind
    corev1GCEPersistentDiskVolumeSource
    +

    Represents a Persistent Disk resource in Google Compute Engine. + +A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.

    + + + + + + + + + +
    FieldDescription
    fsType
    string
    Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
    partition
    integer
    The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
    pdName
    string
    Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
    readOnly
    boolean
    ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
    +

    GitRepoVolumeSource v1 core

    + + + + + +
    GroupVersionKind
    corev1GitRepoVolumeSource
    +

    Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling. + +DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.

    +
    Appears In: + +
    + + + + + + + +
    FieldDescription
    directory
    string
    Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.
    repository
    string
    Repository URL
    revision
    string
    Commit hash for the specified revision.
    +

    GlusterfsPersistentVolumeSource v1 core

    + + + + + +
    GroupVersionKind
    corev1GlusterfsPersistentVolumeSource
    +

    Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.

    +
    Appears In: + +
    + + + + + + + + +
    FieldDescription
    endpoints
    string
    EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
    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
    path
    string
    Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
    readOnly
    boolean
    ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
    +

    GlusterfsVolumeSource v1 core

    + + + + + +
    GroupVersionKind
    corev1GlusterfsVolumeSource
    +

    Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.

    +
    Appears In: + +
    + + + + + + + +
    FieldDescription
    endpoints
    string
    EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
    path
    string
    Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
    readOnly
    boolean
    ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
    +

    GroupSubject v1beta1 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta1GroupSubject
    +

    GroupSubject holds detailed information for group-kind subject.

    +
    Appears In: + +
    + + + + + +
    FieldDescription
    name
    string
    name is the user group that matches, or "*" to match all user groups. See https://github.com/kubernetes/apiserver/blob/master/pkg/authentication/user/user.go for some well-known group names. Required.
    +

    GroupVersionForDiscovery v1 meta

    + + + + + +
    GroupVersionKind
    metav1GroupVersionForDiscovery
    +

    GroupVersion contains the "group/version" and "version" string of a version. It is made a struct to keep extensibility.

    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    groupVersion
    string
    groupVersion specifies the API group and version in the form "group/version"
    version
    string
    version specifies the version in the form of "version". This is to save the clients the trouble of splitting the GroupVersion.
    +

    HPAScalingPolicy v2beta2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta2HPAScalingPolicy
    +

    HPAScalingPolicy is a single policy which must hold true for a specified past interval.

    + + + + + + + + +
    FieldDescription
    periodSeconds
    integer
    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).
    type
    string
    Type is used to specify the scaling policy.
    value
    integer
    Value contains the amount of change which is permitted by the policy. It must be greater than zero
    +

    HPAScalingRules v2beta2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta2HPAScalingRules
    +

    HPAScalingRules configures the scaling behavior for one direction. These Rules are applied after calculating DesiredReplicas from metrics for the HPA. They can limit the scaling velocity by specifying scaling policies. They can prevent flapping by specifying the stabilization window, so that the number of replicas is not set instantly, instead, the safest value from the stabilization window is chosen.

    + + + + + + + + +
    FieldDescription
    policies
    HPAScalingPolicy array
    policies is a list of potential scaling polices which can be used during scaling. At least one policy must be specified, otherwise the HPAScalingRules will be discarded as invalid
    selectPolicy
    string
    selectPolicy is used to specify which policy should be used. If not set, the default value MaxPolicySelect is used.
    stabilizationWindowSeconds
    integer
    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).
    +

    HTTPGetAction v1 core

    + + + + + +
    GroupVersionKind
    corev1HTTPGetAction
    +

    HTTPGetAction describes an action based on HTTP Get requests.

    +
    Appears In: + +
    + + + + + + + + + +
    FieldDescription
    host
    string
    Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
    httpHeaders
    HTTPHeader array
    Custom headers to set in the request. HTTP allows repeated headers.
    path
    string
    Path to access on the HTTP server.
    portName or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
    scheme
    string
    Scheme to use for connecting to the host. Defaults to HTTP.
    +

    HTTPHeader v1 core

    + + + + + +
    GroupVersionKind
    corev1HTTPHeader
    +

    HTTPHeader describes a custom header to be used in HTTP probes

    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    name
    string
    The header field name
    value
    string
    The header field value
    +

    HTTPIngressPath v1 networking.k8s.io

    + + + + + +
    GroupVersionKind
    networking.k8s.iov1HTTPIngressPath
    +

    HTTPIngressPath associates a path with a backend. Incoming urls matching the path are forwarded to the backend.

    +
    Other API versions of this object exist: +v1beta1 +v1beta1 +
    + + + + + + + + +
    FieldDescription
    backend
    IngressBackend
    Backend defines the referenced service endpoint to which the traffic will be forwarded to.
    path
    string
    Path is matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional "path" part of a URL as defined by RFC 3986. Paths must begin with a '/'. When unspecified, all paths from incoming requests are matched.
    pathType
    string
    PathType determines the interpretation of the Path matching. PathType can be one of the following values: * Exact: Matches the URL path exactly. * Prefix: Matches based on a URL path prefix split by '/'. Matching is done on a path element by element basis. A path element refers is the list of labels in the path split by the '/' separator. A request is a match for path p if every p is an element-wise prefix of p of the request path. Note that if the last element of the path is a substring of the last element in request path, it is not a match (e.g. /foo/bar matches /foo/bar/baz, but does not match /foo/barbaz). * ImplementationSpecific: Interpretation of the Path matching is up to the IngressClass. Implementations can treat this as a separate PathType or treat it identically to Prefix or Exact path types. Implementations are required to support all path types.
    +

    HTTPIngressRuleValue v1 networking.k8s.io

    + + + + + +
    GroupVersionKind
    networking.k8s.iov1HTTPIngressRuleValue
    +

    HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http://<host>/<path>?<searchpart> -> backend where where parts of the url correspond to RFC 3986, this resource will be used to match against everything after the last '/' and before the first '?' or '#'.

    +
    Other API versions of this object exist: +v1beta1 +v1beta1 +
    +
    Appears In: + +
    + + + + + +
    FieldDescription
    paths
    HTTPIngressPath array
    A collection of paths that map requests to backends.
    +

    Handler v1 core

    + + + + + +
    GroupVersionKind
    corev1Handler
    +

    Handler defines a specific action that should be taken

    +
    Appears In: + +
    + + + + + + + +
    FieldDescription
    exec
    ExecAction
    One and only one of the following should be specified. Exec specifies the action to take.
    httpGet
    HTTPGetAction
    HTTPGet specifies the http request to perform.
    tcpSocket
    TCPSocketAction
    TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported
    +

    HorizontalPodAutoscalerBehavior v2beta2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta2HorizontalPodAutoscalerBehavior
    +

    HorizontalPodAutoscalerBehavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively).

    + + + + + + + +
    FieldDescription
    scaleDown
    HPAScalingRules
    scaleDown is scaling policy for scaling Down. If not set, the default value is to allow to scale down to minReplicas pods, with a 300 second stabilization window (i.e., the highest recommendation for the last 300sec is used).
    scaleUp
    HPAScalingRules
    scaleUp is scaling policy for scaling Up. If not set, the default value is the higher of: * increase no more than 4 pods per 60 seconds * double the number of pods per 60 seconds No stabilization is used.
    +

    HorizontalPodAutoscalerCondition v2beta2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta2HorizontalPodAutoscalerCondition
    +

    HorizontalPodAutoscalerCondition describes the state of a HorizontalPodAutoscaler at a certain point.

    +
    Other API versions of this object exist: +v2beta1 +
    + + + + + + + + + + +
    FieldDescription
    lastTransitionTime
    Time
    lastTransitionTime is the last time the condition transitioned from one status to another
    message
    string
    message is a human-readable explanation containing details about the transition
    reason
    string
    reason is the reason for the condition's last transition.
    status
    string
    status is the status of the condition (True, False, Unknown)
    type
    string
    type describes the current condition
    +

    HostAlias v1 core

    + + + + + +
    GroupVersionKind
    corev1HostAlias
    +

    HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.

    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    hostnames
    string array
    Hostnames for the above IP address.
    ip
    string
    IP address of the host file entry.
    +

    HostPathVolumeSource v1 core

    + + + + + +
    GroupVersionKind
    corev1HostPathVolumeSource
    +

    Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.

    + + + + + + + +
    FieldDescription
    path
    string
    Path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
    type
    string
    Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
    +

    HostPortRange v1beta1 policy

    + + + + + +
    GroupVersionKind
    policyv1beta1HostPortRange
    +

    HostPortRange defines a range of host ports that will be enabled by a policy for pods to use. It requires both the start and end to be defined.

    + + + + + + + +
    FieldDescription
    max
    integer
    max is the end of the range, inclusive.
    min
    integer
    min is the start of the range, inclusive.
    +

    IDRange v1beta1 policy

    + + + + + +
    GroupVersionKind
    policyv1beta1IDRange
    +

    IDRange provides a min/max of an allowed range of IDs.

    + + + + + + + +
    FieldDescription
    max
    integer
    max is the end of the range, inclusive.
    min
    integer
    min is the start of the range, inclusive.
    +

    IPBlock v1 networking.k8s.io

    + + + + + +
    GroupVersionKind
    networking.k8s.iov1IPBlock
    +

    IPBlock describes a particular CIDR (Ex. "192.168.1.1/24","2001:db9::/64") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.

    + + + + + + + +
    FieldDescription
    cidr
    string
    CIDR is a string representing the IP Block Valid examples are "192.168.1.1/24" or "2001:db9::/64"
    except
    string array
    Except is a slice of CIDRs that should not be included within an IP Block Valid examples are "192.168.1.1/24" or "2001:db9::/64" Except values will be rejected if they are outside the CIDR range
    +

    ISCSIPersistentVolumeSource v1 core

    + + + + + +
    GroupVersionKind
    corev1ISCSIPersistentVolumeSource
    +

    ISCSIPersistentVolumeSource represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.

    +
    Appears In: + +
    + + + + + + + + + + + + + + + +
    FieldDescription
    chapAuthDiscovery
    boolean
    whether support iSCSI Discovery CHAP authentication
    chapAuthSession
    boolean
    whether support iSCSI Session CHAP authentication
    fsType
    string
    Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi
    initiatorName
    string
    Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.
    iqn
    string
    Target iSCSI Qualified Name.
    iscsiInterface
    string
    iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
    lun
    integer
    iSCSI Target Lun number.
    portals
    string array
    iSCSI Target Portal List. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
    readOnly
    boolean
    ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
    secretRef
    SecretReference
    CHAP Secret for iSCSI target and initiator authentication
    targetPortal
    string
    iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
    +

    ISCSIVolumeSource v1 core

    + + + + + +
    GroupVersionKind
    corev1ISCSIVolumeSource
    +

    Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.

    +
    Appears In: + +
    + + + + + + + + + + + + + + + +
    FieldDescription
    chapAuthDiscovery
    boolean
    whether support iSCSI Discovery CHAP authentication
    chapAuthSession
    boolean
    whether support iSCSI Session CHAP authentication
    fsType
    string
    Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi
    initiatorName
    string
    Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.
    iqn
    string
    Target iSCSI Qualified Name.
    iscsiInterface
    string
    iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
    lun
    integer
    iSCSI Target Lun number.
    portals
    string array
    iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
    readOnly
    boolean
    ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
    secretRef
    LocalObjectReference
    CHAP Secret for iSCSI target and initiator authentication
    targetPortal
    string
    iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
    +

    IngressBackend v1 networking.k8s.io

    + + + + + +
    GroupVersionKind
    networking.k8s.iov1IngressBackend
    +

    IngressBackend describes all endpoints for a given service and port.

    +
    Other API versions of this object exist: +v1beta1 +v1beta1 +
    + + + + + + + +
    FieldDescription
    resource
    TypedLocalObjectReference
    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".
    +

    IngressClassParametersReference v1 networking.k8s.io

    + + + + + +
    GroupVersionKind
    networking.k8s.iov1IngressClassParametersReference
    +

    IngressClassParametersReference identifies an API object. This can be used to specify a cluster or namespace-scoped resource.

    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + + + + +
    FieldDescription
    apiGroup
    string
    APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
    kind
    string
    Kind is the type of resource being referenced.
    name
    string
    Name is the name of resource being referenced.
    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".
    scope
    string
    Scope represents if this refers to a cluster or namespace scoped resource. This may be set to "Cluster" (default) or "Namespace". Field can be enabled with IngressClassNamespacedParams feature gate.
    +

    IngressRule v1 networking.k8s.io

    + + + + + +
    GroupVersionKind
    networking.k8s.iov1IngressRule
    +

    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.

    +
    Other API versions of this object exist: +v1beta1 +v1beta1 +
    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    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 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.
    http
    HTTPIngressRuleValue
    +

    IngressServiceBackend v1 networking.k8s.io

    + + + + + +
    GroupVersionKind
    networking.k8s.iov1IngressServiceBackend
    +

    IngressServiceBackend references a Kubernetes Service as a Backend.

    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    name
    string
    Name is the referenced service. The service must exist in the same namespace as the Ingress object.
    port
    ServiceBackendPort
    Port of the referenced service. A port name or port number is required for a IngressServiceBackend.
    +

    IngressTLS v1 networking.k8s.io

    + + + + + +
    GroupVersionKind
    networking.k8s.iov1IngressTLS
    +

    IngressTLS describes the transport layer security associated with an Ingress.

    +
    Other API versions of this object exist: +v1beta1 +v1beta1 +
    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    hosts
    string array
    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.
    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.
    +

    JSON v1 apiextensions.k8s.io

    + + + + + +
    GroupVersionKind
    apiextensions.k8s.iov1JSON
    +

    JSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.

    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + +
    FieldDescription
    +

    JSONSchemaProps v1 apiextensions.k8s.io

    + + + + + +
    GroupVersionKind
    apiextensions.k8s.iov1JSONSchemaProps
    +

    JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/).

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

    JSONSchemaPropsOrArray v1 apiextensions.k8s.io

    + + + + + +
    GroupVersionKind
    apiextensions.k8s.iov1JSONSchemaPropsOrArray
    +

    JSONSchemaPropsOrArray represents a value that can either be a JSONSchemaProps or an array of JSONSchemaProps. Mainly here for serialization purposes.

    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + +
    FieldDescription
    +

    JSONSchemaPropsOrBool v1 apiextensions.k8s.io

    + + + + + +
    GroupVersionKind
    apiextensions.k8s.iov1JSONSchemaPropsOrBool
    +

    JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value. Defaults to true for the boolean property.

    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + +
    FieldDescription
    +

    JobCondition v1 batch

    + + + + + +
    GroupVersionKind
    batchv1JobCondition
    +

    JobCondition describes current state of a job.

    +
    Appears In: + +
    + + + + + + + + + + +
    FieldDescription
    lastProbeTime
    Time
    Last time the condition was checked.
    lastTransitionTime
    Time
    Last time the condition transit from one status to another.
    message
    string
    Human readable message indicating details about last transition.
    reason
    string
    (brief) reason for the condition's last transition.
    status
    string
    Status of the condition, one of True, False, Unknown.
    type
    string
    Type of job condition, Complete or Failed.
    +

    JobTemplateSpec v1 batch

    + + + + + +
    GroupVersionKind
    batchv1JobTemplateSpec
    +

    JobTemplateSpec describes the data a Job should have when created from a template

    +
    Other API versions of this object exist: +v1beta1 +
    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    metadata
    ObjectMeta
    Standard object's metadata of the jobs created from this template. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    spec
    JobSpec
    Specification of the desired behavior of the job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    +

    KeyToPath v1 core

    + + + + + +
    GroupVersionKind
    corev1KeyToPath
    +

    Maps a string key to a path within a volume.

    + + + + + + + + +
    FieldDescription
    key
    string
    The key to project.
    mode
    integer
    Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
    path
    string
    The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
    +

    LabelSelector v1 meta

    + + + + + +
    GroupVersionKind
    metav1LabelSelector
    +

    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.

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

    LabelSelectorRequirement v1 meta

    + + + + + +
    GroupVersionKind
    metav1LabelSelectorRequirement
    +

    A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

    +
    Appears In: + +
    + + + + + + + +
    FieldDescription
    key
    string
    patch strategy: merge
    patch merge key: key
    key is the label key that the selector applies to.
    operator
    string
    operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
    values
    string array
    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
    +

    Lifecycle v1 core

    + + + + + +
    GroupVersionKind
    corev1Lifecycle
    +

    Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.

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

    LimitRangeItem v1 core

    + + + + + +
    GroupVersionKind
    corev1LimitRangeItem
    +

    LimitRangeItem defines a min/max usage limit for any resource that matches on kind.

    +
    Appears In: + +
    + + + + + + + + + + +
    FieldDescription
    default
    object
    Default resource requirement limit value by resource name if resource limit is omitted.
    defaultRequest
    object
    DefaultRequest is the default resource requirement request value by resource name if resource request is omitted.
    max
    object
    Max usage constraints on this kind by resource name.
    maxLimitRequestRatio
    object
    MaxLimitRequestRatio if specified, the named resource must have a request and limit that are both non-zero where limit divided by request is less than or equal to the enumerated value; this represents the max burst for the named resource.
    min
    object
    Min usage constraints on this kind by resource name.
    type
    string
    Type of resource that this limit applies to.
    +

    LimitResponse v1beta1 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta1LimitResponse
    +

    LimitResponse defines how to handle requests that can not be executed right now.

    + + + + + + + +
    FieldDescription
    queuing
    QueuingConfiguration
    `queuing` holds the configuration parameters for queuing. This field may be non-empty only if `type` is `"Queue"`.
    type
    string
    `type` is "Queue" or "Reject". "Queue" means that requests that can not be executed upon arrival are held in a queue until they can be executed or a queuing limit is reached. "Reject" means that requests that can not be executed upon arrival are rejected. Required.
    +

    LimitedPriorityLevelConfiguration v1beta1 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta1LimitedPriorityLevelConfiguration
    +

    LimitedPriorityLevelConfiguration specifies how to handle requests that are subject to limits. It addresses two issues: + * How are requests for this priority level limited? + * What should be done with requests that exceed the limit?

    + + + + + + + +
    FieldDescription
    assuredConcurrencyShares
    integer
    `assuredConcurrencyShares` (ACS) configures the execution limit, which is a limit on the number of requests of this priority level that may be exeucting at a given time. ACS must be a positive number. The server's concurrency limit (SCL) is divided among the concurrency-controlled priority levels in proportion to their assured concurrency shares. This produces the assured concurrency value (ACV) --- the number of requests that may be executing at a time --- for each such priority level: ACV(l) = ceil( SCL * ACS(l) / ( sum[priority levels k] ACS(k) ) ) bigger numbers of ACS mean more reserved concurrent requests (at the expense of every other PL). This field has a default value of 30.
    limitResponse
    LimitResponse
    `limitResponse` indicates what to do with requests that can not be executed right now
    +

    ListMeta v1 meta

    + + + + + +
    GroupVersionKind
    metav1ListMeta
    +

    ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.

    +
    Appears In: + +
    + + + + + + + + +
    FieldDescription
    continue
    string
    continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.
    remainingItemCount
    integer
    remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is *estimating* the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.
    resourceVersion
    string
    String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
    selfLink
    string
    selfLink is a URL representing this object. Populated by the system. Read-only. DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.
    +

    LoadBalancerIngress v1 core

    + + + + + +
    GroupVersionKind
    corev1LoadBalancerIngress
    +

    LoadBalancerIngress represents the status of a load-balancer ingress point: traffic intended for the service should be sent to an ingress point.

    +
    Appears In: + +
    + + + + + + + +
    FieldDescription
    hostname
    string
    Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers)
    ip
    string
    IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers)
    ports
    PortStatus array
    Ports is a list of records of service ports If used, every port defined in the service should have an entry in it
    +

    LoadBalancerStatus v1 core

    + + + + + +
    GroupVersionKind
    corev1LoadBalancerStatus
    +

    LoadBalancerStatus represents the status of a load-balancer.

    + + + + + + +
    FieldDescription
    ingress
    LoadBalancerIngress array
    Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points.
    +

    LocalObjectReference v1 core

    + + + + + +
    GroupVersionKind
    corev1LocalObjectReference
    +

    LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

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

    LocalVolumeSource v1 core

    + + + + + +
    GroupVersionKind
    corev1LocalVolumeSource
    +

    Local represents directly-attached storage with node affinity (Beta feature)

    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    fsType
    string
    Filesystem type to mount. It applies only when the Path is a block device. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default value is to auto-select a fileystem if unspecified.
    path
    string
    The full path to the volume on the node. It can be either a directory or block device (disk, partition, ...).
    +

    ManagedFieldsEntry v1 meta

    + + + + + +
    GroupVersionKind
    metav1ManagedFieldsEntry
    +

    ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.

    +
    Appears In: + +
    + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
    fieldsType
    string
    FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
    fieldsV1
    FieldsV1
    FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
    manager
    string
    Manager is an identifier of the workflow managing these fields.
    operation
    string
    Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
    time
    Time
    Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'
    +

    MetricIdentifier v2beta2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta2MetricIdentifier
    +

    MetricIdentifier defines the name and optionally selector for a metric

    + + + + + + + +
    FieldDescription
    name
    string
    name is the name of the given metric
    selector
    LabelSelector
    selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.
    +

    MetricSpec v2beta2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta2MetricSpec
    +

    MetricSpec specifies how to scale based on a single metric (only `type` and one other matching field should be set at once).

    +
    Other API versions of this object exist: +v2beta1 +
    + + + + + + + + + + + +
    FieldDescription
    containerResource
    ContainerResourceMetricSource
    container resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod of the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. This is an alpha feature and can be enabled by the HPAContainerMetrics feature flag.
    external
    ExternalMetricSource
    external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster).
    object
    ObjectMetricSource
    object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).
    pods
    PodsMetricSource
    pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value.
    resource
    ResourceMetricSource
    resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.
    type
    string
    type is the type of metric source. It should be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each mapping to a matching field in the object. Note: "ContainerResource" type is available on when the feature-gate HPAContainerMetrics is enabled
    +

    MetricStatus v2beta2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta2MetricStatus
    +

    MetricStatus describes the last-read state of a single metric.

    +
    Other API versions of this object exist: +v2beta1 +
    + + + + + + + + + + + +
    FieldDescription
    containerResource
    ContainerResourceMetricStatus
    container resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.
    external
    ExternalMetricStatus
    external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster).
    object
    ObjectMetricStatus
    object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).
    pods
    PodsMetricStatus
    pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value.
    resource
    ResourceMetricStatus
    resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.
    type
    string
    type is the type of metric source. It will be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each corresponds to a matching field in the object. Note: "ContainerResource" type is available on when the feature-gate HPAContainerMetrics is enabled
    +

    MetricTarget v2beta2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta2MetricTarget
    +

    MetricTarget defines the target value, average value, or average utilization of a specific metric

    + + + + + + + + + +
    FieldDescription
    averageUtilization
    integer
    averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. Currently only valid for Resource metric source type
    averageValue
    Quantity
    averageValue is the target value of the average of the metric across all relevant pods (as a quantity)
    type
    string
    type represents whether the metric type is Utilization, Value, or AverageValue
    value
    Quantity
    value is the target value of the metric (as a quantity).
    +

    MetricValueStatus v2beta2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta2MetricValueStatus
    +

    MetricValueStatus holds the current value for a metric

    + + + + + + + + +
    FieldDescription
    averageUtilization
    integer
    currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.
    averageValue
    Quantity
    averageValue is the current value of the average of the metric across all relevant pods (as a quantity)
    value
    Quantity
    value is the current value of the metric (as a quantity).
    +

    MicroTime v1 meta

    + + + + + +
    GroupVersionKind
    metav1MicroTime
    +

    MicroTime is version of Time with microsecond level precision.

    + + + + + +
    FieldDescription
    +

    MutatingWebhook v1 admissionregistration.k8s.io

    + + + + + +
    GroupVersionKind
    admissionregistration.k8s.iov1MutatingWebhook
    +

    MutatingWebhook describes an admission webhook and the resources and operations it applies to.

    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + + + + + + + + + + +
    FieldDescription
    admissionReviewVersions
    string array
    AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` versions the Webhook expects. API server will try to use first version in the list which it supports. If none of the versions specified in this list supported by API server, validation will fail for this object. If a persisted webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail and be subject to the failure policy.
    clientConfig
    WebhookClientConfig
    ClientConfig defines how to communicate with the hook. Required
    failurePolicy
    string
    FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Fail.
    matchPolicy
    string
    matchPolicy defines how the "rules" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". - Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the webhook. - Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the webhook. Defaults to "Equivalent"
    name
    string
    The name of the admission webhook. Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where "imagepolicy" is the name of the webhook, and kubernetes.io is the name of the organization. Required.
    namespaceSelector
    LabelSelector
    NamespaceSelector decides whether to run the webhook on an object based on whether the namespace for that object matches the selector. If the object itself is a namespace, the matching is performed on object.metadata.labels. If the object is another cluster scoped resource, it never skips the webhook. For example, to run the webhook on any objects whose namespace is not associated with "runlevel" of "0" or "1"; you will set the selector as follows: "namespaceSelector": { "matchExpressions": [ { "key": "runlevel", "operator": "NotIn", "values": [ "0", "1" ] } ] } If instead you want to only run the webhook on any objects whose namespace is associated with the "environment" of "prod" or "staging"; you will set the selector as follows: "namespaceSelector": { "matchExpressions": [ { "key": "environment", "operator": "In", "values": [ "prod", "staging" ] } ] } See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ for more examples of label selectors. Default to the empty LabelSelector, which matches everything.
    objectSelector
    LabelSelector
    ObjectSelector decides whether to run the webhook based on if the object has matching labels. objectSelector is evaluated against both the oldObject and newObject that would be sent to the webhook, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. Default to the empty LabelSelector, which matches everything.
    reinvocationPolicy
    string
    reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation. Allowed values are "Never" and "IfNeeded". Never: the webhook will not be called more than once in a single admission evaluation. IfNeeded: the webhook will be called at least one additional time as part of the admission evaluation if the object being admitted is modified by other admission plugins after the initial webhook call. Webhooks that specify this option *must* be idempotent, able to process objects they previously admitted. Note: * the number of additional invocations is not guaranteed to be exactly one. * if additional invocations result in further modifications to the object, webhooks are not guaranteed to be invoked again. * webhooks that use this option may be reordered to minimize the number of additional invocations. * to validate an object after all mutations are guaranteed complete, use a validating admission webhook instead. Defaults to "Never".
    rules
    RuleWithOperations array
    Rules describes what operations on what resources/subresources the webhook cares about. The webhook cares about an operation if it matches _any_ Rule. However, in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks from putting the cluster in a state which cannot be recovered from without completely disabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects.
    sideEffects
    string
    SideEffects states whether this webhook has side effects. Acceptable values are: None, NoneOnDryRun (webhooks created via v1beta1 may also specify Some or Unknown). Webhooks with side effects MUST implement a reconciliation system, since a request may be rejected by a future step in the admission chain and the side effects therefore need to be undone. Requests with the dryRun attribute will be auto-rejected if they match a webhook with sideEffects == Unknown or Some.
    timeoutSeconds
    integer
    TimeoutSeconds specifies the timeout for this webhook. After the timeout passes, the webhook call will be ignored or the API call will fail based on the failure policy. The timeout value must be between 1 and 30 seconds. Default to 10 seconds.
    +

    NFSVolumeSource v1 core

    + + + + + +
    GroupVersionKind
    corev1NFSVolumeSource
    +

    Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.

    + + + + + + + + +
    FieldDescription
    path
    string
    Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
    readOnly
    boolean
    ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
    server
    string
    Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
    +

    NamespaceCondition v1 core

    + + + + + +
    GroupVersionKind
    corev1NamespaceCondition
    +

    NamespaceCondition contains details about state of namespace.

    +
    Appears In: + +
    + + + + + + + + + +
    FieldDescription
    lastTransitionTime
    Time
    message
    string
    reason
    string
    status
    string
    Status of the condition, one of True, False, Unknown.
    type
    string
    Type of namespace controller condition.
    +

    NetworkPolicyEgressRule v1 networking.k8s.io

    + + + + + +
    GroupVersionKind
    networking.k8s.iov1NetworkPolicyEgressRule
    +

    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

    + + + + + + + +
    FieldDescription
    ports
    NetworkPolicyPort array
    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.
    to
    NetworkPolicyPeer array
    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.
    +

    NetworkPolicyIngressRule v1 networking.k8s.io

    + + + + + +
    GroupVersionKind
    networking.k8s.iov1NetworkPolicyIngressRule
    +

    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.

    + + + + + + + +
    FieldDescription
    from
    NetworkPolicyPeer array
    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.
    ports
    NetworkPolicyPort array
    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.
    +

    NetworkPolicyPeer v1 networking.k8s.io

    + + + + + +
    GroupVersionKind
    networking.k8s.iov1NetworkPolicyPeer
    +

    NetworkPolicyPeer describes a peer to allow traffic to/from. Only certain combinations of fields are allowed

    + + + + + + + + +
    FieldDescription
    ipBlock
    IPBlock
    IPBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be.
    namespaceSelector
    LabelSelector
    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.
    podSelector
    LabelSelector
    This is a label selector which selects Pods. This field follows standard label selector semantics; if present but empty, it selects all pods. If NamespaceSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects the Pods matching PodSelector in the policy's own Namespace.
    +

    NetworkPolicyPort v1 networking.k8s.io

    + + + + + +
    GroupVersionKind
    networking.k8s.iov1NetworkPolicyPort
    +

    NetworkPolicyPort describes a port to allow traffic on

    + + + + + + + + +
    FieldDescription
    endPort
    integer
    If set, indicates that the range of ports from port to endPort, inclusive, should be allowed by the policy. This field cannot be defined if the port field is not defined or if the port field is defined as a named (string) port. The endPort must be equal or greater than port. This feature is in Alpha state and should be enabled using the Feature Gate "NetworkPolicyEndPort".
    portThe 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.
    protocol
    string
    The protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP.
    +

    NodeAddress v1 core

    + + + + + +
    GroupVersionKind
    corev1NodeAddress
    +

    NodeAddress contains information for the node's address.

    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    address
    string
    The node address.
    type
    string
    Node address type, one of Hostname, ExternalIP or InternalIP.
    +

    NodeAffinity v1 core

    + + + + + +
    GroupVersionKind
    corev1NodeAffinity
    +

    Node affinity is a group of node affinity scheduling rules.

    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    preferredDuringSchedulingIgnoredDuringExecution
    PreferredSchedulingTerm array
    The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.
    requiredDuringSchedulingIgnoredDuringExecution
    NodeSelector
    If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.
    +

    NodeCondition v1 core

    + + + + + +
    GroupVersionKind
    corev1NodeCondition
    +

    NodeCondition contains condition information for a node.

    +
    Appears In: + +
    + + + + + + + + + + +
    FieldDescription
    lastHeartbeatTime
    Time
    Last time we got an update on a given condition.
    lastTransitionTime
    Time
    Last time the condition transit from one status to another.
    message
    string
    Human readable message indicating details about last transition.
    reason
    string
    (brief) reason for the condition's last transition.
    status
    string
    Status of the condition, one of True, False, Unknown.
    type
    string
    Type of node condition.
    +

    NodeConfigSource v1 core

    + + + + + +
    GroupVersionKind
    corev1NodeConfigSource
    +

    NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil.

    + + + + + + +
    FieldDescription
    configMap
    ConfigMapNodeConfigSource
    ConfigMap is a reference to a Node's ConfigMap
    +

    NodeConfigStatus v1 core

    + + + + + +
    GroupVersionKind
    corev1NodeConfigStatus
    +

    NodeConfigStatus describes the status of the config assigned by Node.Spec.ConfigSource.

    +
    Appears In: + +
    + + + + + + + + +
    FieldDescription
    active
    NodeConfigSource
    Active reports the checkpointed config the node is actively using. Active will represent either the current version of the Assigned config, or the current LastKnownGood config, depending on whether attempting to use the Assigned config results in an error.
    assigned
    NodeConfigSource
    Assigned reports the checkpointed config the node will try to use. When Node.Spec.ConfigSource is updated, the node checkpoints the associated config payload to local disk, along with a record indicating intended config. The node refers to this record to choose its config checkpoint, and reports this record in Assigned. Assigned only updates in the status after the record has been checkpointed to disk. When the Kubelet is restarted, it tries to make the Assigned config the Active config by loading and validating the checkpointed payload identified by Assigned.
    error
    string
    Error describes any problems reconciling the Spec.ConfigSource to the Active config. Errors may occur, for example, attempting to checkpoint Spec.ConfigSource to the local Assigned record, attempting to checkpoint the payload associated with Spec.ConfigSource, attempting to load or validate the Assigned config, etc. Errors may occur at different points while syncing config. Earlier errors (e.g. download or checkpointing errors) will not result in a rollback to LastKnownGood, and may resolve across Kubelet retries. Later errors (e.g. loading or validating a checkpointed config) will result in a rollback to LastKnownGood. In the latter case, it is usually possible to resolve the error by fixing the config assigned in Spec.ConfigSource. You can find additional information for debugging by searching the error message in the Kubelet log. Error is a human-readable description of the error state; machines can check whether or not Error is empty, but should not rely on the stability of the Error text across Kubelet versions.
    lastKnownGood
    NodeConfigSource
    LastKnownGood reports the checkpointed config the node will fall back to when it encounters an error attempting to use the Assigned config. The Assigned config becomes the LastKnownGood config when the node determines that the Assigned config is stable and correct. This is currently implemented as a 10-minute soak period starting when the local record of Assigned config is updated. If the Assigned config is Active at the end of this period, it becomes the LastKnownGood. Note that if Spec.ConfigSource is reset to nil (use local defaults), the LastKnownGood is also immediately reset to nil, because the local default config is always assumed good. You should not make assumptions about the node's method of determining config stability and correctness, as this may change or become configurable in the future.
    +

    NodeDaemonEndpoints v1 core

    + + + + + +
    GroupVersionKind
    corev1NodeDaemonEndpoints
    +

    NodeDaemonEndpoints lists ports opened by daemons running on the Node.

    +
    Appears In: + +
    + + + + + +
    FieldDescription
    kubeletEndpoint
    DaemonEndpoint
    Endpoint on which Kubelet is listening.
    +

    NodeSelector v1 core

    + + + + + +
    GroupVersionKind
    corev1NodeSelector
    +

    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.

    + + + + + + +
    FieldDescription
    nodeSelectorTerms
    NodeSelectorTerm array
    Required. A list of node selector terms. The terms are ORed.
    +

    NodeSelectorRequirement v1 core

    + + + + + +
    GroupVersionKind
    corev1NodeSelectorRequirement
    +

    A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

    +
    Appears In: + +
    + + + + + + + +
    FieldDescription
    key
    string
    The label key that the selector applies to.
    operator
    string
    Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
    values
    string array
    An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
    +

    NodeSelectorTerm v1 core

    + + + + + +
    GroupVersionKind
    corev1NodeSelectorTerm
    +

    A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.

    + + + + + + + +
    FieldDescription
    matchExpressions
    NodeSelectorRequirement array
    A list of node selector requirements by node's labels.
    matchFields
    NodeSelectorRequirement array
    A list of node selector requirements by node's fields.
    +

    NodeSystemInfo v1 core

    + + + + + +
    GroupVersionKind
    corev1NodeSystemInfo
    +

    NodeSystemInfo is a set of ids/uuids to uniquely identify the node.

    +
    Appears In: + +
    + + + + + + + + + + + + + + +
    FieldDescription
    architecture
    string
    The Architecture reported by the node
    bootID
    string
    Boot ID reported by the node.
    containerRuntimeVersion
    string
    ContainerRuntime Version reported by the node through runtime remote API (e.g. docker://1.5.0).
    kernelVersion
    string
    Kernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64).
    kubeProxyVersion
    string
    KubeProxy Version reported by the node.
    kubeletVersion
    string
    Kubelet Version reported by the node.
    machineID
    string
    MachineID reported by the node. For unique machine identification in the cluster this field is preferred. Learn more from man(5) machine-id: http://man7.org/linux/man-pages/man5/machine-id.5.html
    operatingSystem
    string
    The Operating System reported by the node
    osImage
    string
    OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)).
    systemUUID
    string
    SystemUUID reported by the node. For unique machine identification MachineID is preferred. This field is specific to Red Hat hosts https://access.redhat.com/documentation/en-us/red_hat_subscription_management/1/html/rhsm/uuid
    +

    NonResourceAttributes v1 authorization.k8s.io

    + + + + + +
    GroupVersionKind
    authorization.k8s.iov1NonResourceAttributes
    +

    NonResourceAttributes includes the authorization attributes available for non-resource requests to the Authorizer interface

    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + +
    FieldDescription
    path
    string
    Path is the URL path of the request
    verb
    string
    Verb is the standard HTTP verb
    +

    NonResourcePolicyRule v1beta1 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta1NonResourcePolicyRule
    +

    NonResourcePolicyRule is a predicate that matches non-resource requests according to their verb and the target non-resource URL. A NonResourcePolicyRule matches a request if and only if both (a) at least one member of verbs matches the request and (b) at least one member of nonResourceURLs matches the request.

    + + + + + + + +
    FieldDescription
    nonResourceURLs
    string array
    `nonResourceURLs` is a set of url prefixes that a user should have access to and may not be empty. For example: - "/healthz" is legal - "/hea*" is illegal - "/hea" is legal but matches nothing - "/hea/*" also matches nothing - "/healthz/*" matches all per-component health checks. "*" matches all non-resource urls. if it is present, it must be the only entry. Required.
    verbs
    string array
    `verbs` is a list of matching verbs and may not be empty. "*" matches all verbs. If it is present, it must be the only entry. Required.
    +

    NonResourceRule v1 authorization.k8s.io

    + + + + + +
    GroupVersionKind
    authorization.k8s.iov1NonResourceRule
    +

    NonResourceRule holds information that describes a rule for the non-resource

    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + +
    FieldDescription
    nonResourceURLs
    string array
    NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path. "*" means all.
    verbs
    string array
    Verb is a list of kubernetes non-resource API verbs, like: get, post, put, delete, patch, head, options. "*" means all.
    +

    ObjectFieldSelector v1 core

    + + + + + +
    GroupVersionKind
    corev1ObjectFieldSelector
    +

    ObjectFieldSelector selects an APIVersioned field of an object.

    + + + + + + + +
    FieldDescription
    apiVersion
    string
    Version of the schema the FieldPath is written in terms of, defaults to "v1".
    fieldPath
    string
    Path of the field to select in the specified API version.
    +

    ObjectMeta v1 meta

    + + + + + +
    GroupVersionKind
    metav1ObjectMeta
    +

    ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

    +
    Appears In: + +
    + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    annotations
    object
    Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
    clusterName
    string
    The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.
    creationTimestamp
    Time
    CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    deletionGracePeriodSeconds
    integer
    Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
    deletionTimestamp
    Time
    DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    finalizers
    string array
    patch strategy: merge
    Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.
    generateName
    string
    GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
    generation
    integer
    A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
    labels
    object
    Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
    managedFields
    ManagedFieldsEntry array
    ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.
    name
    string
    Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
    namespace
    string
    Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces
    ownerReferences
    OwnerReference array
    patch strategy: merge
    patch merge key: uid
    List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
    resourceVersion
    string
    An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
    selfLink
    string
    SelfLink is a URL representing this object. Populated by the system. Read-only. DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.
    uid
    string
    UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
    +

    ObjectMetricSource v2beta2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta2ObjectMetricSource
    +

    ObjectMetricSource indicates how to scale on a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).

    +
    Other API versions of this object exist: +v2beta1 +
    + + + + + + + + +
    FieldDescription
    describedObject
    CrossVersionObjectReference
    metric
    MetricIdentifier
    metric identifies the target metric by name and selector
    target
    MetricTarget
    target specifies the target value for the given metric
    +

    ObjectMetricStatus v2beta2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta2ObjectMetricStatus
    +

    ObjectMetricStatus indicates the current value of a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).

    +
    Other API versions of this object exist: +v2beta1 +
    + + + + + + + + +
    FieldDescription
    current
    MetricValueStatus
    current contains the current value for the given metric
    describedObject
    CrossVersionObjectReference
    metric
    MetricIdentifier
    metric identifies the target metric by name and selector
    +

    ObjectReference v1 core

    + + + + + +
    GroupVersionKind
    corev1ObjectReference
    +

    ObjectReference contains enough information to let you inspect or modify the referred object.

    + + + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    API version of the referent.
    fieldPath
    string
    If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.
    kind
    string
    Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    name
    string
    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
    namespace
    string
    Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
    resourceVersion
    string
    Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
    uid
    string
    UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
    +

    Overhead v1 node.k8s.io

    + + + + + +
    GroupVersionKind
    node.k8s.iov1Overhead
    +

    Overhead structure represents the resource overhead associated with running a pod.

    +
    Other API versions of this object exist: +v1beta1 +v1alpha1 +
    +
    Appears In: + +
    + + + + + +
    FieldDescription
    podFixed
    object
    PodFixed represents the fixed resource overhead associated with running a pod.
    +

    OwnerReference v1 meta

    + + + + + +
    GroupVersionKind
    metav1OwnerReference
    +

    OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.

    +
    Appears In: + +
    + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    API version of the referent.
    blockOwnerDeletion
    boolean
    If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
    controller
    boolean
    If true, this reference points to the managing controller.
    kind
    string
    Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    name
    string
    Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names
    uid
    string
    UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
    +

    Patch v1 meta

    + + + + + +
    GroupVersionKind
    metav1Patch
    +

    Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.

    + + + + +
    FieldDescription
    +

    PersistentVolumeClaimCondition v1 core

    + + + + + +
    GroupVersionKind
    corev1PersistentVolumeClaimCondition
    +

    PersistentVolumeClaimCondition contails details about state of pvc

    + + + + + + + + + + + +
    FieldDescription
    lastProbeTime
    Time
    Last time we probed the condition.
    lastTransitionTime
    Time
    Last time the condition transitioned from one status to another.
    message
    string
    Human-readable message indicating details about last transition.
    reason
    string
    Unique, this should be a short, machine understandable string that gives the reason for condition's last transition. If it reports "ResizeStarted" that means the underlying persistent volume is being resized.
    status
    string
    type
    string
    +

    PersistentVolumeClaimTemplate v1 core

    + + + + + +
    GroupVersionKind
    corev1PersistentVolumeClaimTemplate
    +

    PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource.

    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    metadata
    ObjectMeta
    May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.
    spec
    PersistentVolumeClaimSpec
    The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.
    +

    PersistentVolumeClaimVolumeSource v1 core

    + + + + + +
    GroupVersionKind
    corev1PersistentVolumeClaimVolumeSource
    +

    PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).

    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    claimName
    string
    ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
    readOnly
    boolean
    Will force the ReadOnly setting in VolumeMounts. Default false.
    +

    PhotonPersistentDiskVolumeSource v1 core

    + + + + + +
    GroupVersionKind
    corev1PhotonPersistentDiskVolumeSource
    +

    Represents a Photon Controller persistent disk resource.

    + + + + + + + +
    FieldDescription
    fsType
    string
    Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
    pdID
    string
    ID that identifies Photon Controller persistent disk
    +

    PodAffinity v1 core

    + + + + + +
    GroupVersionKind
    corev1PodAffinity
    +

    Pod affinity is a group of inter pod affinity scheduling rules.

    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    preferredDuringSchedulingIgnoredDuringExecution
    WeightedPodAffinityTerm array
    The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
    requiredDuringSchedulingIgnoredDuringExecution
    PodAffinityTerm array
    If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
    +

    PodAffinityTerm v1 core

    + + + + + +
    GroupVersionKind
    corev1PodAffinityTerm
    +

    Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running

    + + + + + + + + + +
    FieldDescription
    labelSelector
    LabelSelector
    A label query over a set of resources, in this case pods.
    namespaceSelector
    LabelSelector
    A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. This field is alpha-level and is only honored when PodAffinityNamespaceSelector feature is enabled.
    namespaces
    string array
    namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace"
    topologyKey
    string
    This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
    +

    PodAntiAffinity v1 core

    + + + + + +
    GroupVersionKind
    corev1PodAntiAffinity
    +

    Pod anti affinity is a group of inter pod anti affinity scheduling rules.

    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    preferredDuringSchedulingIgnoredDuringExecution
    WeightedPodAffinityTerm array
    The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
    requiredDuringSchedulingIgnoredDuringExecution
    PodAffinityTerm array
    If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
    +

    PodCondition v1 core

    + + + + + +
    GroupVersionKind
    corev1PodCondition
    +

    PodCondition contains details for the current condition of this pod.

    +
    Appears In: + +
    + + + + + + + + + + +
    FieldDescription
    lastProbeTime
    Time
    Last time we probed the condition.
    lastTransitionTime
    Time
    Last time the condition transitioned from one status to another.
    message
    string
    Human-readable message indicating details about last transition.
    reason
    string
    Unique, one-word, CamelCase reason for the condition's last transition.
    status
    string
    Status is the status of the condition. Can be True, False, Unknown. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions
    type
    string
    Type is the type of the condition. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions
    +

    PodDNSConfig v1 core

    + + + + + +
    GroupVersionKind
    corev1PodDNSConfig
    +

    PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.

    +
    Appears In: + +
    + + + + + + + +
    FieldDescription
    nameservers
    string array
    A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.
    options
    PodDNSConfigOption array
    A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy.
    searches
    string array
    A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed.
    +

    PodDNSConfigOption v1 core

    + + + + + +
    GroupVersionKind
    corev1PodDNSConfigOption
    +

    PodDNSConfigOption defines DNS resolver options of a pod.

    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    name
    string
    Required.
    value
    string
    +

    PodDisruptionBudget v1 policy

    + + + + + +
    GroupVersionKind
    policyv1PodDisruptionBudget
    +

    PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods

    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    spec
    PodDisruptionBudgetSpec
    Specification of the desired behavior of the PodDisruptionBudget.
    status
    PodDisruptionBudgetStatus
    Most recently observed status of the PodDisruptionBudget.
    +

    PodIP v1 core

    + + + + + +
    GroupVersionKind
    corev1PodIP
    +

    IP address information for entries in the (plural) PodIPs field. Each entry includes: + IP: An IP address allocated to the pod. Routable at least within the cluster.

    +
    Appears In: + +
    + + + + + +
    FieldDescription
    ip
    string
    ip is an IP address (IPv4 or IPv6) assigned to the pod
    +

    PodReadinessGate v1 core

    + + + + + +
    GroupVersionKind
    corev1PodReadinessGate
    +

    PodReadinessGate contains the reference to a pod condition

    +
    Appears In: + +
    + + + + + +
    FieldDescription
    conditionType
    string
    ConditionType refers to a condition in the pod's condition list with matching type.
    +

    PodSecurityContext v1 core

    + + + + + +
    GroupVersionKind
    corev1PodSecurityContext
    +

    PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.

    +
    Appears In: + +
    + + + + + + + + + + + + + + +
    FieldDescription
    fsGroup
    integer
    A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- If unset, the Kubelet will not modify the ownership and permissions of any volume.
    fsGroupChangePolicy
    string
    fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used.
    runAsGroup
    integer
    The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
    runAsNonRoot
    boolean
    Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
    runAsUser
    integer
    The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
    seLinuxOptions
    SELinuxOptions
    The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
    seccompProfile
    SeccompProfile
    The seccomp options to use by the containers in this pod.
    supplementalGroups
    integer array
    A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container.
    sysctls
    Sysctl array
    Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch.
    windowsOptions
    WindowsSecurityContextOptions
    The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
    +

    PodsMetricSource v2beta2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta2PodsMetricSource
    +

    PodsMetricSource indicates how to scale on a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value.

    +
    Other API versions of this object exist: +v2beta1 +
    + + + + + + + +
    FieldDescription
    metric
    MetricIdentifier
    metric identifies the target metric by name and selector
    target
    MetricTarget
    target specifies the target value for the given metric
    +

    PodsMetricStatus v2beta2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta2PodsMetricStatus
    +

    PodsMetricStatus indicates the current value of a metric describing each pod in the current scale target (for example, transactions-processed-per-second).

    +
    Other API versions of this object exist: +v2beta1 +
    + + + + + + + +
    FieldDescription
    current
    MetricValueStatus
    current contains the current value for the given metric
    metric
    MetricIdentifier
    metric identifies the target metric by name and selector
    +

    PolicyRule v1 rbac.authorization.k8s.io

    + + + + + +
    GroupVersionKind
    rbac.authorization.k8s.iov1PolicyRule
    +

    PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.

    +
    Other API versions of this object exist: +v1beta1 +v1alpha1 +
    +
    Appears In: + +
    + + + + + + + + + +
    FieldDescription
    apiGroups
    string array
    APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed.
    nonResourceURLs
    string array
    NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.
    resourceNames
    string array
    ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
    resources
    string array
    Resources is a list of resources this rule applies to. ResourceAll represents all resources.
    verbs
    string array
    Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.
    +

    PolicyRulesWithSubjects v1beta1 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta1PolicyRulesWithSubjects
    +

    PolicyRulesWithSubjects prescribes a test that applies to a request to an apiserver. The test considers the subject making the request, the verb being requested, and the resource to be acted upon. This PolicyRulesWithSubjects matches a request if and only if both (a) at least one member of subjects matches the request and (b) at least one member of resourceRules or nonResourceRules matches the request.

    + + + + + + + + +
    FieldDescription
    nonResourceRules
    NonResourcePolicyRule array
    `nonResourceRules` is a list of NonResourcePolicyRules that identify matching requests according to their verb and the target non-resource URL.
    resourceRules
    ResourcePolicyRule array
    `resourceRules` is a slice of ResourcePolicyRules that identify matching requests according to their verb and the target resource. At least one of `resourceRules` and `nonResourceRules` has to be non-empty.
    subjects
    Subject array
    subjects is the list of normal user, serviceaccount, or group that this rule cares about. There must be at least one member in this slice. A slice that includes both the system:authenticated and system:unauthenticated user groups matches every request. Required.
    +

    PortStatus v1 core

    + + + + + +
    GroupVersionKind
    corev1PortStatus
    +

    +
    Appears In: + +
    + + + + + + + +
    FieldDescription
    error
    string
    Error is to record the problem with the service port The format of the error shall comply with the following rules: - built-in error values shall be specified in this file and those shall use CamelCase names - cloud provider specific error values must have names that comply with the format foo.example.com/CamelCase.
    port
    integer
    Port is the port number of the service port of which status is recorded here
    protocol
    string
    Protocol is the protocol of the service port of which status is recorded here The supported values are: "TCP", "UDP", "SCTP"
    +

    PortworxVolumeSource v1 core

    + + + + + +
    GroupVersionKind
    corev1PortworxVolumeSource
    +

    PortworxVolumeSource represents a Portworx volume resource.

    + + + + + + + + +
    FieldDescription
    fsType
    string
    FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
    readOnly
    boolean
    Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
    volumeID
    string
    VolumeID uniquely identifies a Portworx volume
    +

    Preconditions v1 meta

    + + + + + +
    GroupVersionKind
    metav1Preconditions
    +

    Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.

    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    resourceVersion
    string
    Specifies the target ResourceVersion
    uid
    string
    Specifies the target UID.
    +

    PreferredSchedulingTerm v1 core

    + + + + + +
    GroupVersionKind
    corev1PreferredSchedulingTerm
    +

    An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).

    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    preference
    NodeSelectorTerm
    A node selector term, associated with the corresponding weight.
    weight
    integer
    Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
    +

    PriorityLevelConfigurationCondition v1beta1 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta1PriorityLevelConfigurationCondition
    +

    PriorityLevelConfigurationCondition defines the condition of priority level.

    + + + + + + + + + + +
    FieldDescription
    lastTransitionTime
    Time
    `lastTransitionTime` is the last time the condition transitioned from one status to another.
    message
    string
    `message` is a human-readable message indicating details about last transition.
    reason
    string
    `reason` is a unique, one-word, CamelCase reason for the condition's last transition.
    status
    string
    `status` is the status of the condition. Can be True, False, Unknown. Required.
    type
    string
    `type` is the type of the condition. Required.
    +

    PriorityLevelConfigurationReference v1beta1 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta1PriorityLevelConfigurationReference
    +

    PriorityLevelConfigurationReference contains information that points to the "request-priority" being used.

    + + + + + + +
    FieldDescription
    name
    string
    `name` is the name of the priority level configuration being referenced Required.
    +

    Probe v1 core

    + + + + + +
    GroupVersionKind
    corev1Probe
    +

    Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

    + + + + + + + + + + + + + + +
    FieldDescription
    exec
    ExecAction
    One and only one of the following should be specified. Exec specifies the action to take.
    failureThreshold
    integer
    Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
    httpGet
    HTTPGetAction
    HTTPGet specifies the http request to perform.
    initialDelaySeconds
    integer
    Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
    periodSeconds
    integer
    How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
    successThreshold
    integer
    Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
    tcpSocket
    TCPSocketAction
    TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported
    terminationGracePeriodSeconds
    integer
    Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is an alpha field and requires enabling ProbeTerminationGracePeriod feature gate.
    timeoutSeconds
    integer
    Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
    +

    ProjectedVolumeSource v1 core

    + + + + + +
    GroupVersionKind
    corev1ProjectedVolumeSource
    +

    Represents a projected volume source

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

    Quantity resource core

    + + + + + +
    GroupVersionKind
    coreresourceQuantity
    +

    Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. + +The serialization format is: + +<quantity> ::= <signedNumber><suffix> + (Note that <suffix> may be empty, from the "" case in <decimalSI>.) +<digit> ::= 0 | 1 | ... | 9 <digits> ::= <digit> | <digit><digits> <number> ::= <digits> | <digits>.<digits> | <digits>. | .<digits> <sign> ::= "+" | "-" <signedNumber> ::= <number> | <sign><number> <suffix> ::= <binarySI> | <decimalExponent> | <decimalSI> <binarySI> ::= Ki | Mi | Gi | Ti | Pi | Ei + (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) +<decimalSI> ::= m | "" | k | M | G | T | P | E + (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) +<decimalExponent> ::= "e" <signedNumber> | "E" <signedNumber> + +No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. + +When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. + +Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: + a. No precision is lost + b. No fractional digits will be emitted + c. The exponent (or suffix) is as large as possible. +The sign will be omitted unless the number is negative. + +Examples: + 1.5 will be serialized as "1500m" + 1.5Gi will be serialized as "1536Mi" + +Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. + +Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) + +This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.

    + + + + + +
    FieldDescription
    +

    QueuingConfiguration v1beta1 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta1QueuingConfiguration
    +

    QueuingConfiguration holds the configuration parameters for queuing

    + + + + + + + + +
    FieldDescription
    handSize
    integer
    `handSize` is a small positive number that configures the shuffle sharding of requests into queues. When enqueuing a request at this priority level the request's flow identifier (a string pair) is hashed and the hash value is used to shuffle the list of queues and deal a hand of the size specified here. The request is put into one of the shortest queues in that hand. `handSize` must be no larger than `queues`, and should be significantly smaller (so that a few heavy flows do not saturate most of the queues). See the user-facing documentation for more extensive guidance on setting this field. This field has a default value of 8.
    queueLengthLimit
    integer
    `queueLengthLimit` is the maximum number of requests allowed to be waiting in a given queue of this priority level at a time; excess requests are rejected. This value must be positive. If not specified, it will be defaulted to 50.
    queues
    integer
    `queues` is the number of queues for this priority level. The queues exist independently at each apiserver. The value must be positive. Setting it to 1 effectively precludes shufflesharding and thus makes the distinguisher method of associated flow schemas irrelevant. This field has a default value of 64.
    +

    QuobyteVolumeSource v1 core

    + + + + + +
    GroupVersionKind
    corev1QuobyteVolumeSource
    +

    Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.

    + + + + + + + + + + + +
    FieldDescription
    group
    string
    Group to map volume access to Default is no group
    readOnly
    boolean
    ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
    registry
    string
    Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes
    tenant
    string
    Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin
    user
    string
    User to map volume access to Defaults to serivceaccount user
    volume
    string
    Volume is a string that references an already created Quobyte volume by name.
    +

    RBDPersistentVolumeSource v1 core

    + + + + + +
    GroupVersionKind
    corev1RBDPersistentVolumeSource
    +

    Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.

    +
    Appears In: + +
    + + + + + + + + + + + + +
    FieldDescription
    fsType
    string
    Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd
    image
    string
    The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
    keyring
    string
    Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
    monitors
    string array
    A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
    pool
    string
    The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
    readOnly
    boolean
    ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
    secretRef
    SecretReference
    SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
    user
    string
    The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
    +

    RBDVolumeSource v1 core

    + + + + + +
    GroupVersionKind
    corev1RBDVolumeSource
    +

    Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.

    +
    Appears In: + +
    + + + + + + + + + + + + +
    FieldDescription
    fsType
    string
    Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd
    image
    string
    The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
    keyring
    string
    Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
    monitors
    string array
    A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
    pool
    string
    The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
    readOnly
    boolean
    ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
    secretRef
    LocalObjectReference
    SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
    user
    string
    The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
    +

    ReplicaSetCondition v1 apps

    + + + + + +
    GroupVersionKind
    appsv1ReplicaSetCondition
    +

    ReplicaSetCondition describes the state of a replica set at a certain point.

    +
    Appears In: + +
    + + + + + + + + + +
    FieldDescription
    lastTransitionTime
    Time
    The last time the condition transitioned from one status to another.
    message
    string
    A human readable message indicating details about the transition.
    reason
    string
    The reason for the condition's last transition.
    status
    string
    Status of the condition, one of True, False, Unknown.
    type
    string
    Type of replica set condition.
    +

    ReplicationControllerCondition v1 core

    + + + + + +
    GroupVersionKind
    corev1ReplicationControllerCondition
    +

    ReplicationControllerCondition describes the state of a replication controller at a certain point.

    + + + + + + + + + + +
    FieldDescription
    lastTransitionTime
    Time
    The last time the condition transitioned from one status to another.
    message
    string
    A human readable message indicating details about the transition.
    reason
    string
    The reason for the condition's last transition.
    status
    string
    Status of the condition, one of True, False, Unknown.
    type
    string
    Type of replication controller condition.
    +

    ResourceAttributes v1 authorization.k8s.io

    + + + + + +
    GroupVersionKind
    authorization.k8s.iov1ResourceAttributes
    +

    ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface

    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + + + + + + +
    FieldDescription
    group
    string
    Group is the API Group of the Resource. "*" means all.
    name
    string
    Name is the name of the resource being requested for a "get" or deleted for a "delete". "" (empty) means all.
    namespace
    string
    Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces "" (empty) is defaulted for LocalSubjectAccessReviews "" (empty) is empty for cluster-scoped resources "" (empty) means "all" for namespace scoped resources from a SubjectAccessReview or SelfSubjectAccessReview
    resource
    string
    Resource is one of the existing resource types. "*" means all.
    subresource
    string
    Subresource is one of the existing resource types. "" means none.
    verb
    string
    Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all.
    version
    string
    Version is the API Version of the Resource. "*" means all.
    +

    ResourceFieldSelector v1 core

    + + + + + +
    GroupVersionKind
    corev1ResourceFieldSelector
    +

    ResourceFieldSelector represents container resources (cpu, memory) and their output format

    + + + + + + + + +
    FieldDescription
    containerName
    string
    Container name: required for volumes, optional for env vars
    divisor
    Quantity
    Specifies the output format of the exposed resources, defaults to "1"
    resource
    string
    Required: resource to select
    +

    ResourceMetricSource v2beta2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta2ResourceMetricSource
    +

    ResourceMetricSource indicates how to scale on a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). The values will be averaged together before being compared to the target. Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. Only one "target" type should be set.

    +
    Other API versions of this object exist: +v2beta1 +
    + + + + + + + +
    FieldDescription
    name
    string
    name is the name of the resource in question.
    target
    MetricTarget
    target specifies the target value for the given metric
    +

    ResourceMetricStatus v2beta2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta2ResourceMetricStatus
    +

    ResourceMetricStatus indicates the current value of a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.

    +
    Other API versions of this object exist: +v2beta1 +
    + + + + + + + +
    FieldDescription
    current
    MetricValueStatus
    current contains the current value for the given metric
    name
    string
    Name is the name of the resource in question.
    +

    ResourcePolicyRule v1beta1 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta1ResourcePolicyRule
    +

    ResourcePolicyRule is a predicate that matches some resource requests, testing the request's verb and the target resource. A ResourcePolicyRule matches a resource request if and only if: (a) at least one member of verbs matches the request, (b) at least one member of apiGroups matches the request, (c) at least one member of resources matches the request, and (d) least one member of namespaces matches the request.

    + + + + + + + + + + +
    FieldDescription
    apiGroups
    string array
    `apiGroups` is a list of matching API groups and may not be empty. "*" matches all API groups and, if present, must be the only entry. Required.
    clusterScope
    boolean
    `clusterScope` indicates whether to match requests that do not specify a namespace (which happens either because the resource is not namespaced or the request targets all namespaces). If this field is omitted or false then the `namespaces` field must contain a non-empty list.
    namespaces
    string array
    `namespaces` is a list of target namespaces that restricts matches. A request that specifies a target namespace matches only if either (a) this list contains that target namespace or (b) this list contains "*". Note that "*" matches any specified namespace but does not match a request that _does not specify_ a namespace (see the `clusterScope` field for that). This list may be empty, but only if `clusterScope` is true.
    resources
    string array
    `resources` is a list of matching resources (i.e., lowercase and plural) with, if desired, subresource. For example, [ "services", "nodes/status" ]. This list may not be empty. "*" matches all resources and, if present, must be the only entry. Required.
    verbs
    string array
    `verbs` is a list of matching verbs and may not be empty. "*" matches all verbs and, if present, must be the only entry. Required.
    +

    ResourceRequirements v1 core

    + + + + + +
    GroupVersionKind
    corev1ResourceRequirements
    +

    ResourceRequirements describes the compute resource requirements.

    + + + + + + + +
    FieldDescription
    limits
    object
    Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
    requests
    object
    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/
    +

    ResourceRule v1 authorization.k8s.io

    + + + + + +
    GroupVersionKind
    authorization.k8s.iov1ResourceRule
    +

    ResourceRule is the list of actions the subject is allowed to perform on resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.

    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + + + +
    FieldDescription
    apiGroups
    string array
    APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. "*" means all.
    resourceNames
    string array
    ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. "*" means all.
    resources
    string array
    Resources is a list of resources this rule applies to. "*" means all in the specified apiGroups. "*/foo" represents the subresource 'foo' for all resources in the specified apiGroups.
    verbs
    string array
    Verb is a list of kubernetes resource API verbs, like: get, list, watch, create, update, delete, proxy. "*" means all.
    +

    RoleRef v1 rbac.authorization.k8s.io

    + + + + + +
    GroupVersionKind
    rbac.authorization.k8s.iov1RoleRef
    +

    RoleRef contains information that points to the role being used

    +
    Other API versions of this object exist: +v1beta1 +v1alpha1 +
    + + + + + + + + +
    FieldDescription
    apiGroup
    string
    APIGroup is the group for the resource being referenced
    kind
    string
    Kind is the type of resource being referenced
    name
    string
    Name is the name of resource being referenced
    +

    RollingUpdateStatefulSetStrategy v1 apps

    + + + + + +
    GroupVersionKind
    appsv1RollingUpdateStatefulSetStrategy
    +

    RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.

    + + + + + + +
    FieldDescription
    partition
    integer
    Partition indicates the ordinal at which the StatefulSet should be partitioned. Default value is 0.
    +

    RuleWithOperations v1 admissionregistration.k8s.io

    + + + + + +
    GroupVersionKind
    admissionregistration.k8s.iov1RuleWithOperations
    +

    RuleWithOperations is a tuple of Operations and Resources. It is recommended to make sure that all the tuple expansions are valid.

    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + + + + +
    FieldDescription
    apiGroups
    string array
    APIGroups is the API groups the resources belong to. '\*' is all groups. If '\*' is present, the length of the slice must be one. Required.
    apiVersions
    string array
    APIVersions is the API versions the resources belong to. '\*' is all versions. If '\*' is present, the length of the slice must be one. Required.
    operations
    string array
    Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. If '\*' is present, the length of the slice must be one. Required.
    resources
    string array
    Resources is a list of resources this rule applies to. For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '\*' means all resources, but not subresources. 'pods/\*' means all subresources of pods. '\*/scale' means all scale subresources. '\*/\*' means all resources and their subresources. If wildcard is present, the validation rule will ensure resources do not overlap with each other. Depending on the enclosing object, subresources might not be allowed. Required.
    scope
    string
    scope specifies the scope of this rule. Valid values are "Cluster", "Namespaced", and "*" "Cluster" means that only cluster-scoped resources will match this rule. Namespace API objects are cluster-scoped. "Namespaced" means that only namespaced resources will match this rule. "*" means that there are no scope restrictions. Subresources match the scope of their parent resource. Default is "*".
    +

    RunAsGroupStrategyOptions v1beta1 policy

    + + + + + +
    GroupVersionKind
    policyv1beta1RunAsGroupStrategyOptions
    +

    RunAsGroupStrategyOptions defines the strategy type and any options used to create the strategy.

    + + + + + + + +
    FieldDescription
    ranges
    IDRange array
    ranges are the allowed ranges of gids that may be used. If you would like to force a single gid then supply a single range with the same start and end. Required for MustRunAs.
    rule
    string
    rule is the strategy that will dictate the allowable RunAsGroup values that may be set.
    +

    RunAsUserStrategyOptions v1beta1 policy

    + + + + + +
    GroupVersionKind
    policyv1beta1RunAsUserStrategyOptions
    +

    RunAsUserStrategyOptions defines the strategy type and any options used to create the strategy.

    + + + + + + + +
    FieldDescription
    ranges
    IDRange array
    ranges are the allowed ranges of uids that may be used. If you would like to force a single uid then supply a single range with the same start and end. Required for MustRunAs.
    rule
    string
    rule is the strategy that will dictate the allowable RunAsUser values that may be set.
    +

    RuntimeClassStrategyOptions v1beta1 policy

    + + + + + +
    GroupVersionKind
    policyv1beta1RuntimeClassStrategyOptions
    +

    RuntimeClassStrategyOptions define the strategy that will dictate the allowable RuntimeClasses for a pod.

    + + + + + + + +
    FieldDescription
    allowedRuntimeClassNames
    string array
    allowedRuntimeClassNames is an allowlist of RuntimeClass names that may be specified on a pod. A value of "*" means that any RuntimeClass name is allowed, and must be the only item in the list. An empty list requires the RuntimeClassName field to be unset.
    defaultRuntimeClassName
    string
    defaultRuntimeClassName is the default RuntimeClassName to set on the pod. The default MUST be allowed by the allowedRuntimeClassNames list. A value of nil does not mutate the Pod.
    +

    SELinuxOptions v1 core

    + + + + + +
    GroupVersionKind
    corev1SELinuxOptions
    +

    SELinuxOptions are the labels to be applied to the container

    + + + + + + + + + +
    FieldDescription
    level
    string
    Level is SELinux level label that applies to the container.
    role
    string
    Role is a SELinux role label that applies to the container.
    type
    string
    Type is a SELinux type label that applies to the container.
    user
    string
    User is a SELinux user label that applies to the container.
    +

    SELinuxStrategyOptions v1beta1 policy

    + + + + + +
    GroupVersionKind
    policyv1beta1SELinuxStrategyOptions
    +

    SELinuxStrategyOptions defines the strategy type and any options used to create the strategy.

    + + + + + + + +
    FieldDescription
    rule
    string
    rule is the strategy that will dictate the allowable labels that may be set.
    seLinuxOptions
    SELinuxOptions
    seLinuxOptions required to run as; required for MustRunAs More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
    +

    Scale v1 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv1Scale
    +

    Scale represents a scaling request for a resource.

    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
    spec
    ScaleSpec
    defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status.
    status
    ScaleStatus
    current status of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. Read-only.
    +

    ScaleIOPersistentVolumeSource v1 core

    + + + + + +
    GroupVersionKind
    corev1ScaleIOPersistentVolumeSource
    +

    ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume

    +
    Appears In: + +
    + + + + + + + + + + + + + + +
    FieldDescription
    fsType
    string
    Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs"
    gateway
    string
    The host address of the ScaleIO API Gateway.
    protectionDomain
    string
    The name of the ScaleIO Protection Domain for the configured storage.
    readOnly
    boolean
    Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
    secretRef
    SecretReference
    SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
    sslEnabled
    boolean
    Flag to enable/disable SSL communication with Gateway, default false
    storageMode
    string
    Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
    storagePool
    string
    The ScaleIO Storage Pool associated with the protection domain.
    system
    string
    The name of the storage system as configured in ScaleIO.
    volumeName
    string
    The name of a volume already created in the ScaleIO system that is associated with this volume source.
    +

    ScaleIOVolumeSource v1 core

    + + + + + +
    GroupVersionKind
    corev1ScaleIOVolumeSource
    +

    ScaleIOVolumeSource represents a persistent ScaleIO volume

    +
    Appears In: + +
    + + + + + + + + + + + + + + +
    FieldDescription
    fsType
    string
    Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".
    gateway
    string
    The host address of the ScaleIO API Gateway.
    protectionDomain
    string
    The name of the ScaleIO Protection Domain for the configured storage.
    readOnly
    boolean
    Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
    secretRef
    LocalObjectReference
    SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
    sslEnabled
    boolean
    Flag to enable/disable SSL communication with Gateway, default false
    storageMode
    string
    Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
    storagePool
    string
    The ScaleIO Storage Pool associated with the protection domain.
    system
    string
    The name of the storage system as configured in ScaleIO.
    volumeName
    string
    The name of a volume already created in the ScaleIO system that is associated with this volume source.
    +

    Scheduling v1 node.k8s.io

    + + + + + +
    GroupVersionKind
    node.k8s.iov1Scheduling
    +

    Scheduling specifies the scheduling constraints for nodes supporting a RuntimeClass.

    +
    Other API versions of this object exist: +v1beta1 +v1alpha1 +
    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    nodeSelector
    object
    nodeSelector lists labels that must be present on nodes that support this RuntimeClass. Pods using this RuntimeClass can only be scheduled to a node matched by this selector. The RuntimeClass nodeSelector is merged with a pod's existing nodeSelector. Any conflicts will cause the pod to be rejected in admission.
    tolerations
    Toleration array
    tolerations are appended (excluding duplicates) to pods running with this RuntimeClass during admission, effectively unioning the set of nodes tolerated by the pod and the RuntimeClass.
    +

    ScopeSelector v1 core

    + + + + + +
    GroupVersionKind
    corev1ScopeSelector
    +

    A scope selector represents the AND of the selectors represented by the scoped-resource selector requirements.

    +
    Appears In: + +
    + + + + + +
    FieldDescription
    matchExpressions
    ScopedResourceSelectorRequirement array
    A list of scope selector requirements by scope of the resources.
    +

    ScopedResourceSelectorRequirement v1 core

    + + + + + +
    GroupVersionKind
    corev1ScopedResourceSelectorRequirement
    +

    A scoped-resource selector requirement is a selector that contains values, a scope name, and an operator that relates the scope name and values.

    +
    Appears In: + +
    + + + + + + + +
    FieldDescription
    operator
    string
    Represents a scope's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist.
    scopeName
    string
    The name of the scope that the selector applies to.
    values
    string array
    An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
    +

    SeccompProfile v1 core

    + + + + + +
    GroupVersionKind
    corev1SeccompProfile
    +

    SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.

    + + + + + + + +
    FieldDescription
    localhostProfile
    string
    localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost".
    type
    string
    type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.
    +

    SecretEnvSource v1 core

    + + + + + +
    GroupVersionKind
    corev1SecretEnvSource
    +

    SecretEnvSource selects a Secret to populate the environment variables with. + +The contents of the target Secret's Data field will represent the key-value pairs as environment variables.

    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    name
    string
    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
    optional
    boolean
    Specify whether the Secret must be defined
    +

    SecretKeySelector v1 core

    + + + + + +
    GroupVersionKind
    corev1SecretKeySelector
    +

    SecretKeySelector selects a key of a Secret.

    +
    Appears In: + +
    + + + + + + + +
    FieldDescription
    key
    string
    The key of the secret to select from. Must be a valid secret key.
    name
    string
    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
    optional
    boolean
    Specify whether the Secret or its key must be defined
    +

    SecretProjection v1 core

    + + + + + +
    GroupVersionKind
    corev1SecretProjection
    +

    Adapts a secret into a projected volume. + +The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode.

    +
    Appears In: + +
    + + + + + + + +
    FieldDescription
    items
    KeyToPath array
    If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
    name
    string
    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
    optional
    boolean
    Specify whether the Secret or its key must be defined
    +

    SecretReference v1 core

    + + + + + +
    GroupVersionKind
    corev1SecretReference
    +

    SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace

    + + + + + + + +
    FieldDescription
    name
    string
    Name is unique within a namespace to reference a secret resource.
    namespace
    string
    Namespace defines the space within which the secret name must be unique.
    +

    SecretVolumeSource v1 core

    + + + + + +
    GroupVersionKind
    corev1SecretVolumeSource
    +

    Adapts a Secret into a volume. + +The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.

    +
    Appears In: + +
    + + + + + + + + +
    FieldDescription
    defaultMode
    integer
    Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
    items
    KeyToPath array
    If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
    optional
    boolean
    Specify whether the Secret or its keys must be defined
    secretName
    string
    Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
    +

    SecurityContext v1 core

    + + + + + +
    GroupVersionKind
    corev1SecurityContext
    +

    SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.

    + + + + + + + + + + + + + + + + +
    FieldDescription
    allowPrivilegeEscalation
    boolean
    AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN
    capabilities
    Capabilities
    The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.
    privileged
    boolean
    Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.
    procMount
    string
    procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled.
    readOnlyRootFilesystem
    boolean
    Whether this container has a read-only root filesystem. Default is false.
    runAsGroup
    integer
    The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
    runAsNonRoot
    boolean
    Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
    runAsUser
    integer
    The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
    seLinuxOptions
    SELinuxOptions
    The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
    seccompProfile
    SeccompProfile
    The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options.
    windowsOptions
    WindowsSecurityContextOptions
    The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
    +

    ServerAddressByClientCIDR v1 meta

    + + + + + +
    GroupVersionKind
    metav1ServerAddressByClientCIDR
    +

    ServerAddressByClientCIDR helps the client to determine the server address that they should use, depending on the clientCIDR that they match.

    + + + + + + + +
    FieldDescription
    clientCIDR
    string
    The CIDR with which clients can match their IP to figure out the server address that they should use.
    serverAddress
    string
    Address of this server, suitable for a client that matches the above CIDR. This can be a hostname, hostname:port, IP or IP:port.
    +

    ServerStorageVersion v1alpha1 internal.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    internal.apiserver.k8s.iov1alpha1ServerStorageVersion
    +

    An API server instance reports the version it can decode and the version it encodes objects to when persisting objects in the backend.

    + + + + + + + + +
    FieldDescription
    apiServerID
    string
    The ID of the reporting API server.
    decodableVersions
    string array
    The API server can decode objects encoded in these versions. The encodingVersion must be included in the decodableVersions.
    encodingVersion
    string
    The API server encodes the object to this version when persisting it in the backend (e.g., etcd).
    +

    ServiceAccountSubject v1beta1 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta1ServiceAccountSubject
    +

    ServiceAccountSubject holds detailed information for service-account-kind subject.

    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    name
    string
    `name` is the name of matching ServiceAccount objects, or "*" to match regardless of name. Required.
    namespace
    string
    `namespace` is the namespace of matching ServiceAccount objects. Required.
    +

    ServiceAccountTokenProjection v1 core

    + + + + + +
    GroupVersionKind
    corev1ServiceAccountTokenProjection
    +

    ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise).

    +
    Appears In: + +
    + + + + + + + +
    FieldDescription
    audience
    string
    Audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.
    expirationSeconds
    integer
    ExpirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.
    path
    string
    Path is the path relative to the mount point of the file to project the token into.
    +

    ServiceBackendPort v1 networking.k8s.io

    + + + + + +
    GroupVersionKind
    networking.k8s.iov1ServiceBackendPort
    +

    ServiceBackendPort is the service port being referenced.

    + + + + + + + +
    FieldDescription
    name
    string
    Name is the name of the port on the Service. This is a mutually exclusive setting with "Number".
    number
    integer
    Number is the numerical port number (e.g. 80) on the Service. This is a mutually exclusive setting with "Name".
    +

    ServicePort v1 core

    + + + + + +
    GroupVersionKind
    corev1ServicePort
    +

    ServicePort contains information on service's port.

    +
    Appears In: + +
    + + + + + + + + + + +
    FieldDescription
    appProtocol
    string
    The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol. This is a beta field that is guarded by the ServiceAppProtocol feature gate and enabled by default.
    name
    string
    The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. When considering the endpoints for a Service, this must match the 'name' field in the EndpointPort. Optional if only one ServicePort is defined on this service.
    nodePort
    integer
    The port on each node on which this service is exposed when type is NodePort or LoadBalancer. Usually assigned by the system. If a value is specified, in-range, and not in use it will be used, otherwise the operation will fail. If not specified, a port will be allocated if this Service requires one. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type from NodePort to ClusterIP). More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport
    port
    integer
    The port that will be exposed by this service.
    protocol
    string
    The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP.
    targetPortNumber or name of the port to access on the pods targeted by the service. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. If this is a string, it will be looked up as a named port in the target Pod's container ports. If this is not specified, the value of the 'port' field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the 'port' field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service
    +

    ServiceReference v1 admissionregistration.k8s.io

    + + + + + +
    GroupVersionKind
    admissionregistration.k8s.iov1ServiceReference
    +

    ServiceReference holds a reference to Service.legacy.k8s.io

    +
    Other API versions of this object exist: +v1beta1 +v1beta1 +v1beta1 +
    + + + + + + + + + +
    FieldDescription
    name
    string
    `name` is the name of the service. Required
    namespace
    string
    `namespace` is the namespace of the service. Required
    path
    string
    `path` is an optional URL path which will be sent in any request to this service.
    port
    integer
    If specified, the port on the service that hosting webhook. Default to 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive).
    +

    SessionAffinityConfig v1 core

    + + + + + +
    GroupVersionKind
    corev1SessionAffinityConfig
    +

    SessionAffinityConfig represents the configurations of session affinity.

    +
    Appears In: + +
    + + + + + +
    FieldDescription
    clientIP
    ClientIPConfig
    clientIP contains the configurations of Client IP based session affinity.
    +

    StatefulSetCondition v1 apps

    + + + + + +
    GroupVersionKind
    appsv1StatefulSetCondition
    +

    StatefulSetCondition describes the state of a statefulset at a certain point.

    +
    Appears In: + +
    + + + + + + + + + +
    FieldDescription
    lastTransitionTime
    Time
    Last time the condition transitioned from one status to another.
    message
    string
    A human readable message indicating details about the transition.
    reason
    string
    The reason for the condition's last transition.
    status
    string
    Status of the condition, one of True, False, Unknown.
    type
    string
    Type of statefulset condition.
    +

    StatefulSetUpdateStrategy v1 apps

    + + + + + +
    GroupVersionKind
    appsv1StatefulSetUpdateStrategy
    +

    StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. It includes any additional parameters necessary to perform the update for the indicated strategy.

    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    rollingUpdate
    RollingUpdateStatefulSetStrategy
    RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType.
    type
    string
    Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate.
    +

    Status v1 meta

    + + + + + +
    GroupVersionKind
    metav1Status
    +

    Status is a return value for calls that don't return other objects.

    + + + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    code
    integer
    Suggested HTTP return code for this status, 0 if not set.
    details
    StatusDetails
    Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    message
    string
    A human-readable description of the status of this operation.
    metadata
    ListMeta
    Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    reason
    string
    A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.
    status
    string
    Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    +

    StatusCause v1 meta

    + + + + + +
    GroupVersionKind
    metav1StatusCause
    +

    StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.

    +
    Appears In: + +
    + + + + + + + +
    FieldDescription
    field
    string
    The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional. Examples: "name" - the field "name" on the current resource "items[0].name" - the field "name" on the first array entry in "items"
    message
    string
    A human-readable description of the cause of the error. This field may be presented as-is to a reader.
    reason
    string
    A machine-readable description of the cause of the error. If this value is empty there is no information available.
    +

    StatusDetails v1 meta

    + + + + + +
    GroupVersionKind
    metav1StatusDetails
    +

    StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.

    +
    Appears In: + +
    + + + + + + + + + + +
    FieldDescription
    causes
    StatusCause array
    The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.
    group
    string
    The group attribute of the resource associated with the status StatusReason.
    kind
    string
    The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    name
    string
    The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).
    retryAfterSeconds
    integer
    If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action.
    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
    +

    StorageOSPersistentVolumeSource v1 core

    + + + + + +
    GroupVersionKind
    corev1StorageOSPersistentVolumeSource
    +

    Represents a StorageOS persistent volume resource.

    +
    Appears In: + +
    + + + + + + + + + +
    FieldDescription
    fsType
    string
    Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
    readOnly
    boolean
    Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
    secretRef
    ObjectReference
    SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
    volumeName
    string
    VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
    volumeNamespace
    string
    VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.
    +

    StorageOSVolumeSource v1 core

    + + + + + +
    GroupVersionKind
    corev1StorageOSVolumeSource
    +

    Represents a StorageOS persistent volume resource.

    +
    Appears In: + +
    + + + + + + + + + +
    FieldDescription
    fsType
    string
    Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
    readOnly
    boolean
    Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
    secretRef
    LocalObjectReference
    SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
    volumeName
    string
    VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
    volumeNamespace
    string
    VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.
    +

    StorageVersionCondition v1alpha1 internal.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    internal.apiserver.k8s.iov1alpha1StorageVersionCondition
    +

    Describes the state of the storageVersion at a certain point.

    + + + + + + + + + + + +
    FieldDescription
    lastTransitionTime
    Time
    Last time the condition transitioned from one status to another.
    message
    string
    A human readable message indicating details about the transition.
    observedGeneration
    integer
    If set, this represents the .metadata.generation that the condition was set based upon.
    reason
    string
    The reason for the condition's last transition.
    status
    string
    Status of the condition, one of True, False, Unknown.
    type
    string
    Type of the condition.
    +

    Subject v1beta1 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta1Subject
    +

    Subject matches the originator of a request, as identified by the request authentication system. There are three ways of matching an originator; by user, group, or service account.

    +
    Other API versions of this object exist: +v1 +v1alpha1 +
    + + + + + + + + + +
    FieldDescription
    group
    GroupSubject
    kind
    string
    Required
    serviceAccount
    ServiceAccountSubject
    user
    UserSubject
    +

    SubjectRulesReviewStatus v1 authorization.k8s.io

    + + + + + +
    GroupVersionKind
    authorization.k8s.iov1SubjectRulesReviewStatus
    +

    SubjectRulesReviewStatus contains the result of a rules check. This check can be incomplete depending on the set of authorizers the server is configured with and any errors experienced during evaluation. Because authorization rules are additive, if a rule appears in a list it's safe to assume the subject has that permission, even if that list is incomplete.

    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + + + +
    FieldDescription
    evaluationError
    string
    EvaluationError can appear in combination with Rules. It indicates an error occurred during rule evaluation, such as an authorizer that doesn't support rule evaluation, and that ResourceRules and/or NonResourceRules may be incomplete.
    incomplete
    boolean
    Incomplete is true when the rules returned by this call are incomplete. This is most commonly encountered when an authorizer, such as an external authorizer, doesn't support rules evaluation.
    nonResourceRules
    NonResourceRule array
    NonResourceRules is the list of actions the subject is allowed to perform on non-resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.
    resourceRules
    ResourceRule array
    ResourceRules is the list of actions the subject is allowed to perform on resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.
    +

    SupplementalGroupsStrategyOptions v1beta1 policy

    + + + + + +
    GroupVersionKind
    policyv1beta1SupplementalGroupsStrategyOptions
    +

    SupplementalGroupsStrategyOptions defines the strategy type and options used to create the strategy.

    + + + + + + + +
    FieldDescription
    ranges
    IDRange array
    ranges are the allowed ranges of supplemental groups. If you would like to force a single supplemental group then supply a single range with the same start and end. Required for MustRunAs.
    rule
    string
    rule is the strategy that will dictate what supplemental groups is used in the SecurityContext.
    +

    Sysctl v1 core

    + + + + + +
    GroupVersionKind
    corev1Sysctl
    +

    Sysctl defines a kernel parameter to be set

    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    name
    string
    Name of a property to set
    value
    string
    Value of a property to set
    +

    TCPSocketAction v1 core

    + + + + + +
    GroupVersionKind
    corev1TCPSocketAction
    +

    TCPSocketAction describes an action based on opening a socket

    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    host
    string
    Optional: Host name to connect to, defaults to the pod IP.
    portNumber or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
    +

    Taint v1 core

    + + + + + +
    GroupVersionKind
    corev1Taint
    +

    The node this Taint is attached to has the "effect" on any pod that does not tolerate the Taint.

    +
    Appears In: + +
    + + + + + + + + +
    FieldDescription
    effect
    string
    Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.
    key
    string
    Required. The taint key to be applied to a node.
    timeAdded
    Time
    TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints.
    value
    string
    The taint value corresponding to the taint key.
    +

    Time v1 meta

    + + + + + +
    GroupVersionKind
    metav1Time
    +

    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.

    +
    Appears In: + +
    + + + + +
    FieldDescription
    +

    Toleration v1 core

    + + + + + +
    GroupVersionKind
    corev1Toleration
    +

    The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.

    + + + + + + + + + + +
    FieldDescription
    effect
    string
    Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
    key
    string
    Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
    operator
    string
    Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
    tolerationSeconds
    integer
    TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
    value
    string
    Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
    +

    TopologySelectorLabelRequirement v1 core

    + + + + + +
    GroupVersionKind
    corev1TopologySelectorLabelRequirement
    +

    A topology selector requirement is a selector that matches given label. This is an alpha feature and may change in the future.

    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    key
    string
    The label key that the selector applies to.
    values
    string array
    An array of string values. One value must match the label to be selected. Each entry in Values is ORed.
    +

    TopologySelectorTerm v1 core

    + + + + + +
    GroupVersionKind
    corev1TopologySelectorTerm
    +

    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.

    + + + + + + +
    FieldDescription
    matchLabelExpressions
    TopologySelectorLabelRequirement array
    A list of topology selector requirements by labels.
    +

    TopologySpreadConstraint v1 core

    + + + + + +
    GroupVersionKind
    corev1TopologySpreadConstraint
    +

    TopologySpreadConstraint specifies how to spread matching pods among the given topology.

    +
    Appears In: + +
    + + + + + + + + +
    FieldDescription
    labelSelector
    LabelSelector
    LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.
    maxSkew
    integer
    MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0: | zone1 | zone2 | zone3 | | P | P | | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; scheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed.
    topologyKey
    string
    TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each <key, value> as a "bucket", and try to put balanced number of pods into each bucket. It's a required field.
    whenUnsatisfiable
    string
    WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew. A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assigment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field.
    +

    TypedLocalObjectReference v1 core

    + + + + + +
    GroupVersionKind
    corev1TypedLocalObjectReference
    +

    TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.

    + + + + + + + + +
    FieldDescription
    apiGroup
    string
    APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
    kind
    string
    Kind is the type of resource being referenced
    name
    string
    Name is the name of resource being referenced
    +

    UserInfo v1 authentication.k8s.io

    + + + + + +
    GroupVersionKind
    authentication.k8s.iov1UserInfo
    +

    UserInfo holds the information about the user needed to implement the user.Info interface.

    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + + + +
    FieldDescription
    extra
    object
    Any additional information provided by the authenticator.
    groups
    string array
    The names of groups this user is a part of.
    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.
    username
    string
    The name that uniquely identifies this user among all active users.
    +

    UserSubject v1beta1 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta1UserSubject
    +

    UserSubject holds detailed information for user-kind subject.

    +
    Appears In: + +
    + + + + + +
    FieldDescription
    name
    string
    `name` is the username that matches, or "*" to match all usernames. Required.
    +

    ValidatingWebhook v1 admissionregistration.k8s.io

    + + + + + +
    GroupVersionKind
    admissionregistration.k8s.iov1ValidatingWebhook
    +

    ValidatingWebhook describes an admission webhook and the resources and operations it applies to.

    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + + + + + + + + + +
    FieldDescription
    admissionReviewVersions
    string array
    AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` versions the Webhook expects. API server will try to use first version in the list which it supports. If none of the versions specified in this list supported by API server, validation will fail for this object. If a persisted webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail and be subject to the failure policy.
    clientConfig
    WebhookClientConfig
    ClientConfig defines how to communicate with the hook. Required
    failurePolicy
    string
    FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Fail.
    matchPolicy
    string
    matchPolicy defines how the "rules" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". - Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the webhook. - Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the webhook. Defaults to "Equivalent"
    name
    string
    The name of the admission webhook. Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where "imagepolicy" is the name of the webhook, and kubernetes.io is the name of the organization. Required.
    namespaceSelector
    LabelSelector
    NamespaceSelector decides whether to run the webhook on an object based on whether the namespace for that object matches the selector. If the object itself is a namespace, the matching is performed on object.metadata.labels. If the object is another cluster scoped resource, it never skips the webhook. For example, to run the webhook on any objects whose namespace is not associated with "runlevel" of "0" or "1"; you will set the selector as follows: "namespaceSelector": { "matchExpressions": [ { "key": "runlevel", "operator": "NotIn", "values": [ "0", "1" ] } ] } If instead you want to only run the webhook on any objects whose namespace is associated with the "environment" of "prod" or "staging"; you will set the selector as follows: "namespaceSelector": { "matchExpressions": [ { "key": "environment", "operator": "In", "values": [ "prod", "staging" ] } ] } See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels for more examples of label selectors. Default to the empty LabelSelector, which matches everything.
    objectSelector
    LabelSelector
    ObjectSelector decides whether to run the webhook based on if the object has matching labels. objectSelector is evaluated against both the oldObject and newObject that would be sent to the webhook, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. Default to the empty LabelSelector, which matches everything.
    rules
    RuleWithOperations array
    Rules describes what operations on what resources/subresources the webhook cares about. The webhook cares about an operation if it matches _any_ Rule. However, in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks from putting the cluster in a state which cannot be recovered from without completely disabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects.
    sideEffects
    string
    SideEffects states whether this webhook has side effects. Acceptable values are: None, NoneOnDryRun (webhooks created via v1beta1 may also specify Some or Unknown). Webhooks with side effects MUST implement a reconciliation system, since a request may be rejected by a future step in the admission chain and the side effects therefore need to be undone. Requests with the dryRun attribute will be auto-rejected if they match a webhook with sideEffects == Unknown or Some.
    timeoutSeconds
    integer
    TimeoutSeconds specifies the timeout for this webhook. After the timeout passes, the webhook call will be ignored or the API call will fail based on the failure policy. The timeout value must be between 1 and 30 seconds. Default to 10 seconds.
    +

    VolumeAttachmentSource v1 storage.k8s.io

    + + + + + +
    GroupVersionKind
    storage.k8s.iov1VolumeAttachmentSource
    +

    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.

    +
    Other API versions of this object exist: +v1beta1 +v1alpha1 +
    + + + + + + + +
    FieldDescription
    inlineVolumeSpec
    PersistentVolumeSpec
    inlineVolumeSpec contains all the information necessary to attach a persistent volume defined by a pod's inline VolumeSource. This field is populated only for the CSIMigration feature. It contains translated fields from a pod's inline VolumeSource to a PersistentVolumeSpec. This field is beta-level and is only honored by servers that enabled the CSIMigration feature.
    persistentVolumeName
    string
    Name of the persistent volume to attach.
    +

    VolumeDevice v1 core

    + + + + + +
    GroupVersionKind
    corev1VolumeDevice
    +

    volumeDevice describes a mapping of a raw block device within a container.

    + + + + + + + +
    FieldDescription
    devicePath
    string
    devicePath is the path inside of the container that the device will be mapped to.
    name
    string
    name must match the name of a persistentVolumeClaim in the pod
    +

    VolumeError v1 storage.k8s.io

    + + + + + +
    GroupVersionKind
    storage.k8s.iov1VolumeError
    +

    VolumeError captures an error encountered during a volume operation.

    +
    Other API versions of this object exist: +v1beta1 +v1alpha1 +
    + + + + + + + +
    FieldDescription
    message
    string
    String detailing the error encountered during Attach or Detach operation. This string may be logged, so it should not contain sensitive information.
    time
    Time
    Time the error was encountered.
    +

    VolumeMount v1 core

    + + + + + +
    GroupVersionKind
    corev1VolumeMount
    +

    VolumeMount describes a mounting of a Volume within a container.

    + + + + + + + + + + + +
    FieldDescription
    mountPath
    string
    Path within the container at which the volume should be mounted. Must not contain ':'.
    mountPropagation
    string
    mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.
    name
    string
    This must match the Name of a Volume.
    readOnly
    boolean
    Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
    subPath
    string
    Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
    subPathExpr
    string
    Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.
    +

    VolumeNodeAffinity v1 core

    + + + + + +
    GroupVersionKind
    corev1VolumeNodeAffinity
    +

    VolumeNodeAffinity defines constraints that limit what nodes this volume can be accessed from.

    +
    Appears In: + +
    + + + + + +
    FieldDescription
    required
    NodeSelector
    Required specifies hard node constraints that must be met.
    +

    VolumeNodeResources v1 storage.k8s.io

    + + + + + +
    GroupVersionKind
    storage.k8s.iov1VolumeNodeResources
    +

    VolumeNodeResources is a set of resource limits for scheduling of volumes.

    +
    Other API versions of this object exist: +v1beta1 +
    +
    Appears In: + +
    + + + + + +
    FieldDescription
    count
    integer
    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.
    +

    VolumeProjection v1 core

    + + + + + +
    GroupVersionKind
    corev1VolumeProjection
    +

    Projection that may be projected along with other supported volume types

    +
    Appears In: + +
    + + + + + + + + +
    FieldDescription
    configMap
    ConfigMapProjection
    information about the configMap data to project
    downwardAPI
    DownwardAPIProjection
    information about the downwardAPI data to project
    secret
    SecretProjection
    information about the secret data to project
    serviceAccountToken
    ServiceAccountTokenProjection
    information about the serviceAccountToken data to project
    +

    VsphereVirtualDiskVolumeSource v1 core

    + + + + + +
    GroupVersionKind
    corev1VsphereVirtualDiskVolumeSource
    +

    Represents a vSphere volume resource.

    + + + + + + + + + +
    FieldDescription
    fsType
    string
    Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
    storagePolicyID
    string
    Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
    storagePolicyName
    string
    Storage Policy Based Management (SPBM) profile name.
    volumePath
    string
    Path that identifies vSphere volume vmdk
    +

    WatchEvent v1 meta

    + + + + + +
    GroupVersionKind
    metav1WatchEvent
    +

    Event represents a single event to a watched resource.

    + + + + + + +
    FieldDescription
    objectObject is: * If Type is Added or Modified: the new state of the object. * If Type is Deleted: the state of the object immediately before deletion. * If Type is Error: *Status is recommended; other types may make sense depending on context.
    type
    string
    +

    WebhookClientConfig v1 admissionregistration.k8s.io

    + + + + + +
    GroupVersionKind
    admissionregistration.k8s.iov1WebhookClientConfig
    +

    WebhookClientConfig contains the information to make a TLS connection with the webhook

    +
    Other API versions of this object exist: +v1beta1 +v1beta1 +
    + + + + + + + + +
    FieldDescription
    caBundle
    string
    `caBundle` is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. If unspecified, system trust roots on the apiserver are used.
    service
    ServiceReference
    `service` is a reference to the service for this webhook. Either `service` or `url` must be specified. If the webhook is running within the cluster, then you should use `service`.
    url
    string
    `url` gives the location of the webhook, in standard URL form (`scheme://host:port/path`). Exactly one of `url` or `service` must be specified. The `host` should not refer to a service running in the cluster; use the `service` field instead. The host might be resolved via external DNS in some apiservers (e.g., `kube-apiserver` cannot resolve in-cluster DNS as that would be a layering violation). `host` may also be an IP address. Please note that using `localhost` or `127.0.0.1` as a `host` is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster. The scheme must be "https"; the URL must begin with "https://". A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier. Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either.
    +

    WebhookConversion v1 apiextensions.k8s.io

    + + + + + +
    GroupVersionKind
    apiextensions.k8s.iov1WebhookConversion
    +

    WebhookConversion describes how to call a conversion webhook

    + + + + + + + +
    FieldDescription
    clientConfig
    WebhookClientConfig
    clientConfig is the instructions for how to call the webhook if strategy is `Webhook`.
    conversionReviewVersions
    string array
    conversionReviewVersions is an ordered list of preferred `ConversionReview` versions the Webhook expects. The API server will use the first version in the list which it supports. If none of the versions specified in this list are supported by API server, conversion will fail for the custom resource. If a persisted Webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail.
    +

    WeightedPodAffinityTerm v1 core

    + + + + + +
    GroupVersionKind
    corev1WeightedPodAffinityTerm
    +

    The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

    + + + + + + + +
    FieldDescription
    podAffinityTerm
    PodAffinityTerm
    Required. A pod affinity term, associated with the corresponding weight.
    weight
    integer
    weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
    +

    WindowsSecurityContextOptions v1 core

    + + + + + +
    GroupVersionKind
    corev1WindowsSecurityContextOptions
    +

    WindowsSecurityContextOptions contain Windows-specific options and credentials.

    + + + + + + + + +
    FieldDescription
    gmsaCredentialSpec
    string
    GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.
    gmsaCredentialSpecName
    string
    GMSACredentialSpecName is the name of the GMSA credential spec to use.
    runAsUserName
    string
    The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
    +

    OLD API VERSIONS

    + +

    This section contains older versions of resources shown above.

    +

    APIService v1beta1 apiregistration.k8s.io

    + + + + + +
    GroupVersionKind
    apiregistration.k8s.iov1beta1APIService
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    spec
    APIServiceSpec
    Spec contains information for locating and communicating with a server
    status
    APIServiceStatus
    Status contains derived information about an API server
    +

    APIServiceSpec v1beta1 apiregistration

    + + + + + + + + + + + + +
    FieldDescription
    caBundle
    string
    CABundle is a PEM encoded CA bundle which will be used to validate an API server's serving certificate. If unspecified, system trust roots on the apiserver are used.
    group
    string
    Group is the API group name this server hosts
    groupPriorityMinimum
    integer
    GroupPriorityMininum is the priority this group should have at least. Higher priority means that the group is preferred by clients over lower priority ones. Note that other versions of this group might specify even higher GroupPriorityMininum values such that the whole group gets a higher priority. The primary sort is based on GroupPriorityMinimum, ordered highest number to lowest (20 before 10). The secondary sort is based on the alphabetical comparison of the name of the object. (v1.bar before v1.foo) We'd recommend something like: *.k8s.io (except extensions) at 18000 and PaaSes (OpenShift, Deis) are recommended to be in the 2000s
    insecureSkipTLSVerify
    boolean
    InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server. This is strongly discouraged. You should use the CABundle instead.
    service
    ServiceReference
    Service is a reference to the service for this API server. It must communicate on port 443. If the Service is nil, that means the handling for the API groupversion is handled locally on this server. The call will simply delegate to the normal handler chain to be fulfilled.
    version
    string
    Version is the API version this server hosts. For example, "v1"
    versionPriority
    integer
    VersionPriority controls the ordering of this API version inside of its group. Must be greater than zero. The primary sort is based on VersionPriority, ordered highest to lowest (20 before 10). Since it's inside of a group, the number can be small, probably in the 10s. In case of equal version priorities, the version string will be used to compute the order inside a group. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10.
    +

    APIServiceStatus v1beta1 apiregistration

    + + + + + + +
    FieldDescription
    conditions
    APIServiceCondition array
    patch strategy: merge
    patch merge key: type
    Current service state of apiService.
    +

    APIServiceList v1beta1 apiregistration

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    APIService array
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    +

    Write Operations

    +

    Create

    +

    create an APIService

    +

    HTTP Request

    +POST /apis/apiregistration.k8s.io/v1beta1/apiservices +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    APIService
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    APIService
    OK
    201
    APIService
    Created
    202
    APIService
    Accepted
    +

    Patch

    +

    partially update the specified APIService

    +

    HTTP Request

    +PATCH /apis/apiregistration.k8s.io/v1beta1/apiservices/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the APIService
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    APIService
    OK
    +

    Replace

    +

    replace the specified APIService

    +

    HTTP Request

    +PUT /apis/apiregistration.k8s.io/v1beta1/apiservices/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the APIService
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    APIService
    +

    Response

    + + + + + + +
    CodeDescription
    200
    APIService
    OK
    201
    APIService
    Created
    +

    Delete

    +

    delete an APIService

    +

    HTTP Request

    +DELETE /apis/apiregistration.k8s.io/v1beta1/apiservices/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the APIService
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of APIService

    +

    HTTP Request

    +DELETE /apis/apiregistration.k8s.io/v1beta1/apiservices +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified APIService

    +

    HTTP Request

    +GET /apis/apiregistration.k8s.io/v1beta1/apiservices/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the APIService
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    APIService
    OK
    +

    List

    +

    list or watch objects of kind APIService

    +

    HTTP Request

    +GET /apis/apiregistration.k8s.io/v1beta1/apiservices +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    APIServiceList
    OK
    +

    Watch

    +

    watch changes to an object of kind APIService. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/apiregistration.k8s.io/v1beta1/watch/apiservices/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the APIService
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of APIService. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/apiregistration.k8s.io/v1beta1/watch/apiservices +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Status Operations

    +

    Patch Status

    +

    partially update status of the specified APIService

    +

    HTTP Request

    +PATCH /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}/status +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the APIService
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    APIService
    OK
    +

    Read Status

    +

    read status of the specified APIService

    +

    HTTP Request

    +GET /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}/status +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the APIService
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    APIService
    OK
    +

    Replace Status

    +

    replace status of the specified APIService

    +

    HTTP Request

    +PUT /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}/status +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the APIService
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    APIService
    +

    Response

    + + + + + + +
    CodeDescription
    200
    APIService
    OK
    201
    APIService
    Created
    +

    APIServiceCondition v1beta1 apiregistration.k8s.io

    + + + + + +
    GroupVersionKind
    apiregistration.k8s.iov1beta1APIServiceCondition
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + + + + +
    FieldDescription
    lastTransitionTime
    Time
    Last time the condition transitioned from one status to another.
    message
    string
    Human-readable message indicating details about last transition.
    reason
    string
    Unique, one-word, CamelCase reason for the condition's last transition.
    status
    string
    Status is the status of the condition. Can be True, False, Unknown.
    type
    string
    Type is the type of the condition.
    +

    AggregationRule v1beta1 rbac.authorization.k8s.io

    + + + + + +
    GroupVersionKind
    rbac.authorization.k8s.iov1beta1AggregationRule
    +
    Other API versions of this object exist: +v1 +v1alpha1 +
    +
    Appears In: + +
    + + + + + +
    FieldDescription
    clusterRoleSelectors
    LabelSelector array
    ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. If any of the selectors match, then the ClusterRole's permissions will be added
    +

    AggregationRule v1alpha1 rbac.authorization.k8s.io

    + + + + + +
    GroupVersionKind
    rbac.authorization.k8s.iov1alpha1AggregationRule
    +
    Other API versions of this object exist: +v1 +v1beta1 +
    +
    Appears In: + +
    + + + + + +
    FieldDescription
    clusterRoleSelectors
    LabelSelector array
    ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. If any of the selectors match, then the ClusterRole's permissions will be added
    +

    CSIDriver v1beta1 storage.k8s.io

    + + + + + +
    GroupVersionKind
    storage.k8s.iov1beta1CSIDriver
    +
    Other API versions of this object exist: +v1 +
    +
    Appears In: + +
    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object metadata. metadata.Name indicates the name of the CSI driver that this object refers to; it MUST be the same name returned by the CSI GetPluginName() call for that driver. The driver name must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), dots (.), and alphanumerics between. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    spec
    CSIDriverSpec
    Specification of the CSI Driver.
    +

    CSIDriverSpec v1beta1 storage

    +
    Appears In: + +
    + + + + + + + + + + + +
    FieldDescription
    attachRequired
    boolean
    attachRequired indicates this CSI volume driver requires an attach operation (because it implements the CSI ControllerPublishVolume() method), and that the Kubernetes attach detach controller should call the attach volume interface which checks the volumeattachment status and waits until the volume is attached before proceeding to mounting. The CSI external-attacher coordinates with CSI volume driver and updates the volumeattachment status when the attach operation is complete. If the CSIDriverRegistry feature gate is enabled and the value is specified to false, the attach operation will be skipped. Otherwise the attach operation will be called. This field is immutable.
    fsGroupPolicy
    string
    Defines if the underlying volume supports changing ownership and permission of the volume before being mounted. Refer to the specific FSGroupPolicy values for additional details. This field is alpha-level, and is only honored by servers that enable the CSIVolumeFSGroupPolicy feature gate. This field is immutable.
    podInfoOnMount
    boolean
    If set to true, podInfoOnMount indicates this CSI volume driver requires additional pod information (like podName, podUID, etc.) during mount operations. If set to false, pod information will not be passed on mount. Default is false. The CSI driver specifies podInfoOnMount as part of driver deployment. If true, Kubelet will pass pod information as VolumeContext in the CSI NodePublishVolume() calls. The CSI driver is responsible for parsing and validating the information passed in as VolumeContext. The following VolumeConext will be passed if podInfoOnMount is set to true. This list might grow, but the prefix will be used. "csi.storage.k8s.io/pod.name": pod.Name "csi.storage.k8s.io/pod.namespace": pod.Namespace "csi.storage.k8s.io/pod.uid": string(pod.UID) "csi.storage.k8s.io/ephemeral": "true" if the volume is an ephemeral inline volume defined by a CSIVolumeSource, otherwise "false" "csi.storage.k8s.io/ephemeral" is a new feature in Kubernetes 1.16. It is only required for drivers which support both the "Persistent" and "Ephemeral" VolumeLifecycleMode. Other drivers can leave pod info disabled and/or ignore this field. As Kubernetes 1.15 doesn't support this field, drivers can only support one mode when deployed on such a cluster and the deployment determines which mode that is, for example via a command line parameter of the driver. This field is immutable.
    requiresRepublish
    boolean
    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. This is a beta feature and only available when the CSIServiceAccountToken feature is enabled.
    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. 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. Alternatively, the driver can be deployed with the field unset or false and it can be flipped later when storage capacity information has been published. This field is immutable. This is a beta field and only available when the CSIStorageCapacity feature is enabled. The default is false.
    tokenRequests
    TokenRequest array
    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>, }, ... } Note: Audience in each TokenRequest should be different and at most one token is empty string. To receive a new token after expiry, RequiresRepublish can be used to trigger NodePublishVolume periodically. This is a beta feature and only available when the CSIServiceAccountToken feature is enabled.
    volumeLifecycleModes
    string array
    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 immutable.
    +

    CSIDriverList v1beta1 storage

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    CSIDriver array
    items is the list of CSIDriver
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    +

    Write Operations

    +

    Create

    +

    create a CSIDriver

    +

    HTTP Request

    +POST /apis/storage.k8s.io/v1beta1/csidrivers +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    CSIDriver
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    CSIDriver
    OK
    201
    CSIDriver
    Created
    202
    CSIDriver
    Accepted
    +

    Patch

    +

    partially update the specified CSIDriver

    +

    HTTP Request

    +PATCH /apis/storage.k8s.io/v1beta1/csidrivers/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CSIDriver
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    CSIDriver
    OK
    +

    Replace

    +

    replace the specified CSIDriver

    +

    HTTP Request

    +PUT /apis/storage.k8s.io/v1beta1/csidrivers/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CSIDriver
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    CSIDriver
    +

    Response

    + + + + + + +
    CodeDescription
    200
    CSIDriver
    OK
    201
    CSIDriver
    Created
    +

    Delete

    +

    delete a CSIDriver

    +

    HTTP Request

    +DELETE /apis/storage.k8s.io/v1beta1/csidrivers/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CSIDriver
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    CSIDriver
    OK
    202
    CSIDriver
    Accepted
    +

    Delete Collection

    +

    delete collection of CSIDriver

    +

    HTTP Request

    +DELETE /apis/storage.k8s.io/v1beta1/csidrivers +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified CSIDriver

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1beta1/csidrivers/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CSIDriver
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    CSIDriver
    OK
    +

    List

    +

    list or watch objects of kind CSIDriver

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1beta1/csidrivers +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    CSIDriverList
    OK
    +

    Watch

    +

    watch changes to an object of kind CSIDriver. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1beta1/watch/csidrivers/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CSIDriver
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of CSIDriver. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1beta1/watch/csidrivers +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    CSINode v1beta1 storage.k8s.io

    + + + + + +
    GroupVersionKind
    storage.k8s.iov1beta1CSINode
    +
    Other API versions of this object exist: +v1 +
    +
    Appears In: + +
    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    metadata.name must be the Kubernetes node name.
    spec
    CSINodeSpec
    spec is the specification of CSINode
    +

    CSINodeSpec v1beta1 storage

    +
    Appears In: + +
    + + + + + +
    FieldDescription
    drivers
    CSINodeDriver array
    patch strategy: merge
    patch merge key: name
    drivers is a list of information of all CSI Drivers existing on a node. If all drivers in the list are uninstalled, this can become empty.
    +

    CSINodeList v1beta1 storage

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    CSINode array
    items is the list of CSINode
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    +

    Write Operations

    +

    Create

    +

    create a CSINode

    +

    HTTP Request

    +POST /apis/storage.k8s.io/v1beta1/csinodes +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    CSINode
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    CSINode
    OK
    201
    CSINode
    Created
    202
    CSINode
    Accepted
    +

    Patch

    +

    partially update the specified CSINode

    +

    HTTP Request

    +PATCH /apis/storage.k8s.io/v1beta1/csinodes/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CSINode
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    CSINode
    OK
    +

    Replace

    +

    replace the specified CSINode

    +

    HTTP Request

    +PUT /apis/storage.k8s.io/v1beta1/csinodes/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CSINode
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    CSINode
    +

    Response

    + + + + + + +
    CodeDescription
    200
    CSINode
    OK
    201
    CSINode
    Created
    +

    Delete

    +

    delete a CSINode

    +

    HTTP Request

    +DELETE /apis/storage.k8s.io/v1beta1/csinodes/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CSINode
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    CSINode
    OK
    202
    CSINode
    Accepted
    +

    Delete Collection

    +

    delete collection of CSINode

    +

    HTTP Request

    +DELETE /apis/storage.k8s.io/v1beta1/csinodes +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified CSINode

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1beta1/csinodes/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CSINode
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    CSINode
    OK
    +

    List

    +

    list or watch objects of kind CSINode

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1beta1/csinodes +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    CSINodeList
    OK
    +

    Watch

    +

    watch changes to an object of kind CSINode. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1beta1/watch/csinodes/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CSINode
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of CSINode. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1beta1/watch/csinodes +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    CSINodeDriver v1beta1 storage.k8s.io

    + + + + + +
    GroupVersionKind
    storage.k8s.iov1beta1CSINodeDriver
    +
    Other API versions of this object exist: +v1 +
    +
    Appears In: + +
    + + + + + + + + +
    FieldDescription
    allocatable
    VolumeNodeResources
    allocatable represents the volume resources of a node that are available for scheduling.
    name
    string
    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.
    nodeID
    string
    nodeID of the node from the driver point of view. This field enables Kubernetes to communicate with storage systems that do not share the same nomenclature for nodes. For example, Kubernetes may refer to a given node as "node1", but the storage system may refer to the same node as "nodeA". When Kubernetes issues a command to the storage system to attach a volume to a specific node, it can use this field to refer to the node name using the ID that the storage system will understand, e.g. "nodeA" instead of "node1". This field is required.
    topologyKeys
    string array
    topologyKeys is the list of keys supported by the driver. When a driver is initialized on a cluster, it provides a set of topology keys that it understands (e.g. "company.com/zone", "company.com/region"). When a driver is initialized on a node, it provides the same topology keys along with values. Kubelet will expose these topology keys as labels on its own node object. When Kubernetes does topology aware provisioning, it can use this list to determine which labels it should retrieve from the node object and pass back to the driver. It is possible for different nodes to use different topology keys. This can be empty if driver does not support topology.
    +

    CSIStorageCapacity v1alpha1 storage.k8s.io

    + + + + + +
    GroupVersionKind
    storage.k8s.iov1alpha1CSIStorageCapacity
    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    capacity
    Quantity
    Capacity is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields. The semantic is currently (CSI spec 1.2) defined as: The available capacity, in bytes, of the storage that can be used to provision volumes. If not set, that information is currently unavailable and treated like zero capacity.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    maximumVolumeSize
    Quantity
    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.
    metadata
    ObjectMeta
    Standard object's metadata. The name has no particular meaning. It must be be a DNS subdomain (dots allowed, 253 characters). To ensure that there are no conflicts with other CSI drivers on the cluster, the recommendation is to use csisc-<uuid>, a generated name, or a reverse-domain name which ends with the unique CSI driver name. Objects are namespaced. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    nodeTopology
    LabelSelector
    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.
    storageClassName
    string
    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.
    +

    CSIStorageCapacityList v1alpha1 storage

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    CSIStorageCapacity array
    Items is the list of CSIStorageCapacity objects.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    +

    Write Operations

    +

    Create

    +

    create a CSIStorageCapacity

    +

    HTTP Request

    +POST /apis/storage.k8s.io/v1alpha1/namespaces/{namespace}/csistoragecapacities +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    CSIStorageCapacity
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    CSIStorageCapacity
    OK
    201
    CSIStorageCapacity
    Created
    202
    CSIStorageCapacity
    Accepted
    +

    Patch

    +

    partially update the specified CSIStorageCapacity

    +

    HTTP Request

    +PATCH /apis/storage.k8s.io/v1alpha1/namespaces/{namespace}/csistoragecapacities/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the CSIStorageCapacity
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    CSIStorageCapacity
    OK
    +

    Replace

    +

    replace the specified CSIStorageCapacity

    +

    HTTP Request

    +PUT /apis/storage.k8s.io/v1alpha1/namespaces/{namespace}/csistoragecapacities/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the CSIStorageCapacity
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    CSIStorageCapacity
    +

    Response

    + + + + + + +
    CodeDescription
    200
    CSIStorageCapacity
    OK
    201
    CSIStorageCapacity
    Created
    +

    Delete

    +

    delete a CSIStorageCapacity

    +

    HTTP Request

    +DELETE /apis/storage.k8s.io/v1alpha1/namespaces/{namespace}/csistoragecapacities/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the CSIStorageCapacity
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of CSIStorageCapacity

    +

    HTTP Request

    +DELETE /apis/storage.k8s.io/v1alpha1/namespaces/{namespace}/csistoragecapacities +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified CSIStorageCapacity

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1alpha1/namespaces/{namespace}/csistoragecapacities/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the CSIStorageCapacity
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    CSIStorageCapacity
    OK
    +

    List

    +

    list or watch objects of kind CSIStorageCapacity

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1alpha1/namespaces/{namespace}/csistoragecapacities +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    CSIStorageCapacityList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind CSIStorageCapacity

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1alpha1/csistoragecapacities +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    CSIStorageCapacityList
    OK
    +

    Watch

    +

    watch changes to an object of kind CSIStorageCapacity. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1alpha1/watch/namespaces/{namespace}/csistoragecapacities/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the CSIStorageCapacity
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of CSIStorageCapacity. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1alpha1/watch/namespaces/{namespace}/csistoragecapacities +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of CSIStorageCapacity. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1alpha1/watch/csistoragecapacities +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    CertificateSigningRequest v1beta1 certificates.k8s.io

    + + + + + +
    GroupVersionKind
    certificates.k8s.iov1beta1CertificateSigningRequest
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    spec
    CertificateSigningRequestSpec
    The certificate request itself and any additional information.
    status
    CertificateSigningRequestStatus
    Derived information about the request.
    +

    CertificateSigningRequestSpec v1beta1 certificates

    + + + + + + + + + + + + +
    FieldDescription
    extra
    object
    Extra information about the requesting user. See user.Info interface for details.
    groups
    string array
    Group information about the requesting user. See user.Info interface for details.
    request
    string
    Base64-encoded PKCS#10 CSR data
    signerName
    string
    Requested signer for the request. It is a qualified name in the form: `scope-hostname.io/name`. If empty, it will be defaulted: 1. If it's a kubelet client certificate, it is assigned "kubernetes.io/kube-apiserver-client-kubelet". 2. If it's a kubelet serving certificate, it is assigned "kubernetes.io/kubelet-serving". 3. Otherwise, it is assigned "kubernetes.io/legacy-unknown". Distribution of trust for signers happens out of band. You can select on this field using `spec.signerName`.
    uid
    string
    UID information about the requesting user. See user.Info interface for details.
    usages
    string array
    allowedUsages specifies a set of usage contexts the key will be valid for. See: https://tools.ietf.org/html/rfc5280#section-4.2.1.3 https://tools.ietf.org/html/rfc5280#section-4.2.1.12 Valid values are: "signing", "digital signature", "content commitment", "key encipherment", "key agreement", "data encipherment", "cert sign", "crl sign", "encipher only", "decipher only", "any", "server auth", "client auth", "code signing", "email protection", "s/mime", "ipsec end system", "ipsec tunnel", "ipsec user", "timestamping", "ocsp signing", "microsoft sgc", "netscape sgc"
    username
    string
    Information about the requesting user. See user.Info interface for details.
    +

    CertificateSigningRequestStatus v1beta1 certificates

    + + + + + + + +
    FieldDescription
    certificate
    string
    If request was approved, the controller will place the issued certificate here.
    conditions
    CertificateSigningRequestCondition array
    Conditions applied to the request, such as approval or denial.
    +

    CertificateSigningRequestList v1beta1 certificates

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    CertificateSigningRequest array
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    +

    Write Operations

    +

    Create

    +

    create a CertificateSigningRequest

    +

    HTTP Request

    +POST /apis/certificates.k8s.io/v1beta1/certificatesigningrequests +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    CertificateSigningRequest
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    CertificateSigningRequest
    OK
    201
    CertificateSigningRequest
    Created
    202
    CertificateSigningRequest
    Accepted
    +

    Patch

    +

    partially update the specified CertificateSigningRequest

    +

    HTTP Request

    +PATCH /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CertificateSigningRequest
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    CertificateSigningRequest
    OK
    +

    Replace

    +

    replace the specified CertificateSigningRequest

    +

    HTTP Request

    +PUT /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CertificateSigningRequest
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    CertificateSigningRequest
    +

    Response

    + + + + + + +
    CodeDescription
    200
    CertificateSigningRequest
    OK
    201
    CertificateSigningRequest
    Created
    +

    Delete

    +

    delete a CertificateSigningRequest

    +

    HTTP Request

    +DELETE /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CertificateSigningRequest
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of CertificateSigningRequest

    +

    HTTP Request

    +DELETE /apis/certificates.k8s.io/v1beta1/certificatesigningrequests +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified CertificateSigningRequest

    +

    HTTP Request

    +GET /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CertificateSigningRequest
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    CertificateSigningRequest
    OK
    +

    List

    +

    list or watch objects of kind CertificateSigningRequest

    +

    HTTP Request

    +GET /apis/certificates.k8s.io/v1beta1/certificatesigningrequests +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    CertificateSigningRequestList
    OK
    +

    Watch

    +

    watch changes to an object of kind CertificateSigningRequest. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/certificates.k8s.io/v1beta1/watch/certificatesigningrequests/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CertificateSigningRequest
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of CertificateSigningRequest. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/certificates.k8s.io/v1beta1/watch/certificatesigningrequests +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Status Operations

    +

    Patch Status

    +

    partially update status of the specified CertificateSigningRequest

    +

    HTTP Request

    +PATCH /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}/status +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CertificateSigningRequest
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    CertificateSigningRequest
    OK
    +

    Read Status

    +

    read status of the specified CertificateSigningRequest

    +

    HTTP Request

    +GET /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}/status +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CertificateSigningRequest
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    CertificateSigningRequest
    OK
    +

    Replace Status

    +

    replace status of the specified CertificateSigningRequest

    +

    HTTP Request

    +PUT /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}/status +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CertificateSigningRequest
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    CertificateSigningRequest
    +

    Response

    + + + + + + +
    CodeDescription
    200
    CertificateSigningRequest
    OK
    201
    CertificateSigningRequest
    Created
    +

    CertificateSigningRequestCondition v1beta1 certificates.k8s.io

    + + + + + +
    GroupVersionKind
    certificates.k8s.iov1beta1CertificateSigningRequestCondition
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + + + + + +
    FieldDescription
    lastTransitionTime
    Time
    lastTransitionTime is the time the condition last transitioned from one status to another. If unset, when a new condition type is added or an existing condition's status is changed, the server defaults this to the current time.
    lastUpdateTime
    Time
    timestamp for the last update to this condition
    message
    string
    human readable message with details about the request state
    reason
    string
    brief reason for the request state
    status
    string
    Status of the condition, one of True, False, Unknown. Approved, Denied, and Failed conditions may not be "False" or "Unknown". Defaults to "True". If unset, should be treated as "True".
    type
    string
    type of the condition. Known conditions include "Approved", "Denied", and "Failed".
    +

    ClusterRole v1beta1 rbac.authorization.k8s.io

    + + + + + +
    GroupVersionKind
    rbac.authorization.k8s.iov1beta1ClusterRole
    +
    Other API versions of this object exist: +v1 +v1alpha1 +
    +
    Appears In: + +
    + + + + + + + + + +
    FieldDescription
    aggregationRule
    AggregationRule
    AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. If AggregationRule is set, then the Rules are controller managed and direct changes to Rules will be stomped by the controller.
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata.
    rules
    PolicyRule array
    Rules holds all the PolicyRules for this ClusterRole
    +

    ClusterRoleList v1beta1 rbac

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    ClusterRole array
    Items is a list of ClusterRoles
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard object's metadata.
    +

    Write Operations

    +

    Create

    +

    create a ClusterRole

    +

    HTTP Request

    +POST /apis/rbac.authorization.k8s.io/v1beta1/clusterroles +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    ClusterRole
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    ClusterRole
    OK
    201
    ClusterRole
    Created
    202
    ClusterRole
    Accepted
    +

    Patch

    +

    partially update the specified ClusterRole

    +

    HTTP Request

    +PATCH /apis/rbac.authorization.k8s.io/v1beta1/clusterroles/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the ClusterRole
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    ClusterRole
    OK
    +

    Replace

    +

    replace the specified ClusterRole

    +

    HTTP Request

    +PUT /apis/rbac.authorization.k8s.io/v1beta1/clusterroles/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the ClusterRole
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    ClusterRole
    +

    Response

    + + + + + + +
    CodeDescription
    200
    ClusterRole
    OK
    201
    ClusterRole
    Created
    +

    Delete

    +

    delete a ClusterRole

    +

    HTTP Request

    +DELETE /apis/rbac.authorization.k8s.io/v1beta1/clusterroles/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the ClusterRole
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of ClusterRole

    +

    HTTP Request

    +DELETE /apis/rbac.authorization.k8s.io/v1beta1/clusterroles +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified ClusterRole

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1beta1/clusterroles/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the ClusterRole
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    ClusterRole
    OK
    +

    List

    +

    list or watch objects of kind ClusterRole

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1beta1/clusterroles +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    ClusterRoleList
    OK
    +

    Watch

    +

    watch changes to an object of kind ClusterRole. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1beta1/watch/clusterroles/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the ClusterRole
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of ClusterRole. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1beta1/watch/clusterroles +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    ClusterRole v1alpha1 rbac.authorization.k8s.io

    + + + + + +
    GroupVersionKind
    rbac.authorization.k8s.iov1alpha1ClusterRole
    +
    Other API versions of this object exist: +v1 +v1beta1 +
    +
    Appears In: + +
    + + + + + + + + + +
    FieldDescription
    aggregationRule
    AggregationRule
    AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. If AggregationRule is set, then the Rules are controller managed and direct changes to Rules will be stomped by the controller.
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata.
    rules
    PolicyRule array
    Rules holds all the PolicyRules for this ClusterRole
    +

    ClusterRoleList v1alpha1 rbac

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    ClusterRole array
    Items is a list of ClusterRoles
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard object's metadata.
    +

    Write Operations

    +

    Create

    +

    create a ClusterRole

    +

    HTTP Request

    +POST /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    ClusterRole
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    ClusterRole
    OK
    201
    ClusterRole
    Created
    202
    ClusterRole
    Accepted
    +

    Patch

    +

    partially update the specified ClusterRole

    +

    HTTP Request

    +PATCH /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the ClusterRole
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    ClusterRole
    OK
    +

    Replace

    +

    replace the specified ClusterRole

    +

    HTTP Request

    +PUT /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the ClusterRole
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    ClusterRole
    +

    Response

    + + + + + + +
    CodeDescription
    200
    ClusterRole
    OK
    201
    ClusterRole
    Created
    +

    Delete

    +

    delete a ClusterRole

    +

    HTTP Request

    +DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the ClusterRole
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of ClusterRole

    +

    HTTP Request

    +DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified ClusterRole

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the ClusterRole
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    ClusterRole
    OK
    +

    List

    +

    list or watch objects of kind ClusterRole

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    ClusterRoleList
    OK
    +

    Watch

    +

    watch changes to an object of kind ClusterRole. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterroles/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the ClusterRole
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of ClusterRole. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterroles +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    ClusterRoleBinding v1beta1 rbac.authorization.k8s.io

    + + + + + +
    GroupVersionKind
    rbac.authorization.k8s.iov1beta1ClusterRoleBinding
    +
    Other API versions of this object exist: +v1 +v1alpha1 +
    + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata.
    roleRef
    RoleRef
    RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.
    subjects
    Subject array
    Subjects holds references to the objects the role applies to.
    +

    ClusterRoleBindingList v1beta1 rbac

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    ClusterRoleBinding array
    Items is a list of ClusterRoleBindings
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard object's metadata.
    +

    Write Operations

    +

    Create

    +

    create a ClusterRoleBinding

    +

    HTTP Request

    +POST /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    ClusterRoleBinding
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    ClusterRoleBinding
    OK
    201
    ClusterRoleBinding
    Created
    202
    ClusterRoleBinding
    Accepted
    +

    Patch

    +

    partially update the specified ClusterRoleBinding

    +

    HTTP Request

    +PATCH /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the ClusterRoleBinding
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    ClusterRoleBinding
    OK
    +

    Replace

    +

    replace the specified ClusterRoleBinding

    +

    HTTP Request

    +PUT /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the ClusterRoleBinding
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    ClusterRoleBinding
    +

    Response

    + + + + + + +
    CodeDescription
    200
    ClusterRoleBinding
    OK
    201
    ClusterRoleBinding
    Created
    +

    Delete

    +

    delete a ClusterRoleBinding

    +

    HTTP Request

    +DELETE /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the ClusterRoleBinding
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of ClusterRoleBinding

    +

    HTTP Request

    +DELETE /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified ClusterRoleBinding

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the ClusterRoleBinding
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    ClusterRoleBinding
    OK
    +

    List

    +

    list or watch objects of kind ClusterRoleBinding

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    ClusterRoleBindingList
    OK
    +

    Watch

    +

    watch changes to an object of kind ClusterRoleBinding. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1beta1/watch/clusterrolebindings/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the ClusterRoleBinding
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of ClusterRoleBinding. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1beta1/watch/clusterrolebindings +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    ClusterRoleBinding v1alpha1 rbac.authorization.k8s.io

    + + + + + +
    GroupVersionKind
    rbac.authorization.k8s.iov1alpha1ClusterRoleBinding
    +
    Other API versions of this object exist: +v1 +v1beta1 +
    + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata.
    roleRef
    RoleRef
    RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.
    subjects
    Subject array
    Subjects holds references to the objects the role applies to.
    +

    ClusterRoleBindingList v1alpha1 rbac

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    ClusterRoleBinding array
    Items is a list of ClusterRoleBindings
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard object's metadata.
    +

    Write Operations

    +

    Create

    +

    create a ClusterRoleBinding

    +

    HTTP Request

    +POST /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    ClusterRoleBinding
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    ClusterRoleBinding
    OK
    201
    ClusterRoleBinding
    Created
    202
    ClusterRoleBinding
    Accepted
    +

    Patch

    +

    partially update the specified ClusterRoleBinding

    +

    HTTP Request

    +PATCH /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the ClusterRoleBinding
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    ClusterRoleBinding
    OK
    +

    Replace

    +

    replace the specified ClusterRoleBinding

    +

    HTTP Request

    +PUT /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the ClusterRoleBinding
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    ClusterRoleBinding
    +

    Response

    + + + + + + +
    CodeDescription
    200
    ClusterRoleBinding
    OK
    201
    ClusterRoleBinding
    Created
    +

    Delete

    +

    delete a ClusterRoleBinding

    +

    HTTP Request

    +DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the ClusterRoleBinding
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of ClusterRoleBinding

    +

    HTTP Request

    +DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified ClusterRoleBinding

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the ClusterRoleBinding
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    ClusterRoleBinding
    OK
    +

    List

    +

    list or watch objects of kind ClusterRoleBinding

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    ClusterRoleBindingList
    OK
    +

    Watch

    +

    watch changes to an object of kind ClusterRoleBinding. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterrolebindings/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the ClusterRoleBinding
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of ClusterRoleBinding. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterrolebindings +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    ContainerResourceMetricSource v2beta1 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta1ContainerResourceMetricSource
    +
    Other API versions of this object exist: +v2beta2 +
    + + + + + + + + + +
    FieldDescription
    container
    string
    container is the name of the container in the pods of the scaling target
    name
    string
    name is the name of the resource in question.
    targetAverageUtilization
    integer
    targetAverageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.
    targetAverageValue
    Quantity
    targetAverageValue is the target value of the average of the resource metric across all relevant pods, as a raw value (instead of as a percentage of the request), similar to the "pods" metric source type.
    +

    ContainerResourceMetricStatus v2beta1 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta1ContainerResourceMetricStatus
    +
    Other API versions of this object exist: +v2beta2 +
    + + + + + + + + + +
    FieldDescription
    container
    string
    container is the name of the container in the pods of the scaling target
    currentAverageUtilization
    integer
    currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. It will only be present if `targetAverageValue` was set in the corresponding metric specification.
    currentAverageValue
    Quantity
    currentAverageValue is the current value of the average of the resource metric across all relevant pods, as a raw value (instead of as a percentage of the request), similar to the "pods" metric source type. It will always be set, regardless of the corresponding metric specification.
    name
    string
    name is the name of the resource in question.
    +

    CronJob v1beta1 batch

    + + + + + +
    GroupVersionKind
    batchv1beta1CronJob
    +
    Other API versions of this object exist: +v1 +
    +
    Appears In: + +
    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    spec
    CronJobSpec
    Specification of the desired behavior of a cron job, including the schedule. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    status
    CronJobStatus
    Current status of a cron job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    +

    CronJobSpec v1beta1 batch

    +
    Appears In: + +
    + + + + + + + + + + + +
    FieldDescription
    concurrencyPolicy
    string
    Specifies how to treat concurrent executions of a Job. Valid values are: - "Allow" (default): allows CronJobs to run concurrently; - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet; - "Replace": cancels currently running job and replaces it with a new one
    failedJobsHistoryLimit
    integer
    The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
    jobTemplate
    JobTemplateSpec
    Specifies the job that will be created when executing a CronJob.
    schedule
    string
    The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
    startingDeadlineSeconds
    integer
    Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones.
    successfulJobsHistoryLimit
    integer
    The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 3.
    suspend
    boolean
    This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.
    +

    CronJobStatus v1beta1 batch

    +
    Appears In: + +
    + + + + + + + +
    FieldDescription
    active
    ObjectReference array
    A list of pointers to currently running jobs.
    lastScheduleTime
    Time
    Information when was the last time the job was successfully scheduled.
    lastSuccessfulTime
    Time
    Information when was the last time the job successfully completed.
    +

    CronJobList v1beta1 batch

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    CronJob array
    items is the list of CronJobs.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    +

    Write Operations

    +

    Create

    +

    create a CronJob

    +

    HTTP Request

    +POST /apis/batch/v1beta1/namespaces/{namespace}/cronjobs +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    CronJob
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    CronJob
    OK
    201
    CronJob
    Created
    202
    CronJob
    Accepted
    +

    Patch

    +

    partially update the specified CronJob

    +

    HTTP Request

    +PATCH /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the CronJob
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    CronJob
    OK
    +

    Replace

    +

    replace the specified CronJob

    +

    HTTP Request

    +PUT /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the CronJob
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    CronJob
    +

    Response

    + + + + + + +
    CodeDescription
    200
    CronJob
    OK
    201
    CronJob
    Created
    +

    Delete

    +

    delete a CronJob

    +

    HTTP Request

    +DELETE /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the CronJob
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of CronJob

    +

    HTTP Request

    +DELETE /apis/batch/v1beta1/namespaces/{namespace}/cronjobs +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified CronJob

    +

    HTTP Request

    +GET /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the CronJob
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    CronJob
    OK
    +

    List

    +

    list or watch objects of kind CronJob

    +

    HTTP Request

    +GET /apis/batch/v1beta1/namespaces/{namespace}/cronjobs +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    CronJobList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind CronJob

    +

    HTTP Request

    +GET /apis/batch/v1beta1/cronjobs +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    CronJobList
    OK
    +

    Watch

    +

    watch changes to an object of kind CronJob. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/batch/v1beta1/watch/namespaces/{namespace}/cronjobs/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the CronJob
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of CronJob. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/batch/v1beta1/watch/namespaces/{namespace}/cronjobs +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of CronJob. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/batch/v1beta1/watch/cronjobs +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Status Operations

    +

    Patch Status

    +

    partially update status of the specified CronJob

    +

    HTTP Request

    +PATCH /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the CronJob
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    CronJob
    OK
    +

    Read Status

    +

    read status of the specified CronJob

    +

    HTTP Request

    +GET /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the CronJob
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    CronJob
    OK
    +

    Replace Status

    +

    replace status of the specified CronJob

    +

    HTTP Request

    +PUT /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the CronJob
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    CronJob
    +

    Response

    + + + + + + +
    CodeDescription
    200
    CronJob
    OK
    201
    CronJob
    Created
    +

    CrossVersionObjectReference v2beta2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta2CrossVersionObjectReference
    +
    Other API versions of this object exist: +v1 +v2beta1 +
    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    API version of the referent
    kind
    string
    Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"
    name
    string
    Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
    +

    CrossVersionObjectReference v2beta1 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta1CrossVersionObjectReference
    +
    Other API versions of this object exist: +v1 +v2beta2 +
    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    API version of the referent
    kind
    string
    Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"
    name
    string
    Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
    +

    CustomResourceColumnDefinition v1beta1 apiextensions.k8s.io

    + + + + + +
    GroupVersionKind
    apiextensions.k8s.iov1beta1CustomResourceColumnDefinition
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + + + + + +
    FieldDescription
    JSONPath
    string
    JSONPath is a simple JSON path (i.e. with array notation) which is evaluated against each custom resource to produce the value for this column.
    description
    string
    description is a human readable description of this column.
    format
    string
    format is an optional OpenAPI type definition for this column. The 'name' format is applied to the primary identifier column to assist in clients identifying column is the resource name. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details.
    name
    string
    name is a human readable name for the column.
    priority
    integer
    priority is an integer defining the relative importance of this column compared to others. Lower numbers are considered higher priority. Columns that may be omitted in limited space scenarios should be given a priority greater than 0.
    type
    string
    type is an OpenAPI type definition for this column. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details.
    +

    CustomResourceConversion v1beta1 apiextensions.k8s.io

    + + + + + +
    GroupVersionKind
    apiextensions.k8s.iov1beta1CustomResourceConversion
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + + +
    FieldDescription
    conversionReviewVersions
    string array
    conversionReviewVersions is an ordered list of preferred `ConversionReview` versions the Webhook expects. The API server will use the first version in the list which it supports. If none of the versions specified in this list are supported by API server, conversion will fail for the custom resource. If a persisted Webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail. Defaults to `["v1beta1"]`.
    strategy
    string
    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.webhookClientConfig to be set.
    webhookClientConfig
    WebhookClientConfig
    webhookClientConfig is the instructions for how to call the webhook if strategy is `Webhook`. Required when `strategy` is set to `Webhook`.
    +

    CustomResourceDefinition v1beta1 apiextensions.k8s.io

    + + + + + +
    GroupVersionKind
    apiextensions.k8s.iov1beta1CustomResourceDefinition
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    spec
    CustomResourceDefinitionSpec
    spec describes how the user wants the resources to appear
    status
    CustomResourceDefinitionStatus
    status indicates the actual state of the CustomResourceDefinition
    +

    CustomResourceDefinitionSpec v1beta1 apiextensions

    + + + + + + + + + + + + + + + +
    FieldDescription
    additionalPrinterColumns
    CustomResourceColumnDefinition array
    additionalPrinterColumns specifies additional columns returned in Table output. See https://kubernetes.io/docs/reference/using-api/api-concepts/#receiving-resources-as-tables for details. If present, this field configures columns for all versions. Top-level and per-version columns are mutually exclusive. If no top-level or per-version columns are specified, a single column displaying the age of the custom resource is used.
    conversion
    CustomResourceConversion
    conversion defines conversion settings for the CRD.
    group
    string
    group is the API group of the defined custom resource. The custom resources are served under `/apis/<group>/...`. Must match the name of the CustomResourceDefinition (in the form `<names.plural>.<group>`).
    names
    CustomResourceDefinitionNames
    names specify the resource and kind names for the custom resource.
    preserveUnknownFields
    boolean
    preserveUnknownFields indicates that object fields which are not specified in the OpenAPI schema should be preserved when persisting to storage. apiVersion, kind, metadata and known fields inside metadata are always preserved. If false, schemas must be defined for all versions. Defaults to true in v1beta for backwards compatibility. Deprecated: will be required to be false in v1. Preservation of unknown fields can be specified in the validation schema using the `x-kubernetes-preserve-unknown-fields: true` extension. See https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#pruning-versus-preserving-unknown-fields for details.
    scope
    string
    scope indicates whether the defined custom resource is cluster- or namespace-scoped. Allowed values are `Cluster` and `Namespaced`. Default is `Namespaced`.
    subresources
    CustomResourceSubresources
    subresources specify what subresources the defined custom resource has. If present, this field configures subresources for all versions. Top-level and per-version subresources are mutually exclusive.
    validation
    CustomResourceValidation
    validation describes the schema used for validation and pruning of the custom resource. If present, this validation schema is used to validate all versions. Top-level and per-version schemas are mutually exclusive.
    version
    string
    version is the API version of the defined custom resource. The custom resources are served under `/apis/<group>/<version>/...`. Must match the name of the first item in the `versions` list if `version` and `versions` are both specified. Optional if `versions` is specified. Deprecated: use `versions` instead.
    versions
    CustomResourceDefinitionVersion array
    versions is the list of all API versions of the defined custom resource. Optional if `version` is specified. The name of the first item in the `versions` list must match the `version` field if `version` and `versions` are both specified. Version names are used to compute the order in which served versions are listed in API discovery. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10.
    +

    CustomResourceDefinitionStatus v1beta1 apiextensions

    + + + + + + + + +
    FieldDescription
    acceptedNames
    CustomResourceDefinitionNames
    acceptedNames are the names that are actually being used to serve discovery. They may be different than the names in spec.
    conditions
    CustomResourceDefinitionCondition array
    conditions indicate state for particular aspects of a CustomResourceDefinition
    storedVersions
    string array
    storedVersions lists all versions of CustomResources that were ever persisted. Tracking these versions allows a migration path for stored versions in etcd. The field is mutable so a migration controller can finish a migration to another version (ensuring no old objects are left in storage), and then remove the rest of the versions from this list. Versions may not be removed from `spec.versions` while they exist in this list.
    +

    CustomResourceDefinitionList v1beta1 apiextensions

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    CustomResourceDefinition array
    items list individual CustomResourceDefinition objects
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    +

    Write Operations

    +

    Create

    +

    create a CustomResourceDefinition

    +

    HTTP Request

    +POST /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    CustomResourceDefinition
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    CustomResourceDefinition
    OK
    201
    CustomResourceDefinition
    Created
    202
    CustomResourceDefinition
    Accepted
    +

    Patch

    +

    partially update the specified CustomResourceDefinition

    +

    HTTP Request

    +PATCH /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CustomResourceDefinition
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    CustomResourceDefinition
    OK
    +

    Replace

    +

    replace the specified CustomResourceDefinition

    +

    HTTP Request

    +PUT /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CustomResourceDefinition
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    CustomResourceDefinition
    +

    Response

    + + + + + + +
    CodeDescription
    200
    CustomResourceDefinition
    OK
    201
    CustomResourceDefinition
    Created
    +

    Delete

    +

    delete a CustomResourceDefinition

    +

    HTTP Request

    +DELETE /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CustomResourceDefinition
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of CustomResourceDefinition

    +

    HTTP Request

    +DELETE /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified CustomResourceDefinition

    +

    HTTP Request

    +GET /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CustomResourceDefinition
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    CustomResourceDefinition
    OK
    +

    List

    +

    list or watch objects of kind CustomResourceDefinition

    +

    HTTP Request

    +GET /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    CustomResourceDefinitionList
    OK
    +

    Watch

    +

    watch changes to an object of kind CustomResourceDefinition. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/apiextensions.k8s.io/v1beta1/watch/customresourcedefinitions/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CustomResourceDefinition
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of CustomResourceDefinition. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/apiextensions.k8s.io/v1beta1/watch/customresourcedefinitions +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Status Operations

    +

    Patch Status

    +

    partially update status of the specified CustomResourceDefinition

    +

    HTTP Request

    +PATCH /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}/status +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CustomResourceDefinition
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    CustomResourceDefinition
    OK
    +

    Read Status

    +

    read status of the specified CustomResourceDefinition

    +

    HTTP Request

    +GET /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}/status +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CustomResourceDefinition
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    CustomResourceDefinition
    OK
    +

    Replace Status

    +

    replace status of the specified CustomResourceDefinition

    +

    HTTP Request

    +PUT /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}/status +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the CustomResourceDefinition
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    CustomResourceDefinition
    +

    Response

    + + + + + + +
    CodeDescription
    200
    CustomResourceDefinition
    OK
    201
    CustomResourceDefinition
    Created
    +

    CustomResourceDefinitionCondition v1beta1 apiextensions.k8s.io

    + + + + + +
    GroupVersionKind
    apiextensions.k8s.iov1beta1CustomResourceDefinitionCondition
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + + + + +
    FieldDescription
    lastTransitionTime
    Time
    lastTransitionTime last time the condition transitioned from one status to another.
    message
    string
    message is a human-readable message indicating details about last transition.
    reason
    string
    reason is a unique, one-word, CamelCase reason for the condition's last transition.
    status
    string
    status is the status of the condition. Can be True, False, Unknown.
    type
    string
    type is the type of the condition. Types include Established, NamesAccepted and Terminating.
    +

    CustomResourceDefinitionNames v1beta1 apiextensions.k8s.io

    + + + + + +
    GroupVersionKind
    apiextensions.k8s.iov1beta1CustomResourceDefinitionNames
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + + + + + +
    FieldDescription
    categories
    string array
    categories is a list of grouped resources this custom resource belongs to (e.g. 'all'). This is published in API discovery documents, and used by clients to support invocations like `kubectl get all`.
    kind
    string
    kind is the serialized kind of the resource. It is normally CamelCase and singular. Custom resource instances will use this value as the `kind` attribute in API calls.
    listKind
    string
    listKind is the serialized kind of the list for this resource. Defaults to "`kind`List".
    plural
    string
    plural is the plural name of the resource to serve. The custom resources are served under `/apis/<group>/<version>/.../<plural>`. Must match the name of the CustomResourceDefinition (in the form `<names.plural>.<group>`). Must be all lowercase.
    shortNames
    string array
    shortNames are short names for the resource, exposed in API discovery documents, and used by clients to support invocations like `kubectl get <shortname>`. It must be all lowercase.
    singular
    string
    singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased `kind`.
    +

    CustomResourceDefinitionVersion v1beta1 apiextensions.k8s.io

    + + + + + +
    GroupVersionKind
    apiextensions.k8s.iov1beta1CustomResourceDefinitionVersion
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + + + + + + + +
    FieldDescription
    additionalPrinterColumns
    CustomResourceColumnDefinition array
    additionalPrinterColumns specifies additional columns returned in Table output. See https://kubernetes.io/docs/reference/using-api/api-concepts/#receiving-resources-as-tables for details. Top-level and per-version columns are mutually exclusive. Per-version columns must not all be set to identical values (top-level columns should be used instead). If no top-level or per-version columns are specified, a single column displaying the age of the custom resource is used.
    deprecated
    boolean
    deprecated indicates this version of the custom resource API is deprecated. When set to true, API requests to this version receive a warning header in the server response. Defaults to false.
    deprecationWarning
    string
    deprecationWarning overrides the default warning returned to API clients. May only be set when `deprecated` is true. The default warning indicates this version is deprecated and recommends use of the newest served version of equal or greater stability, if one exists.
    name
    string
    name is the version name, e.g. “v1”, “v2beta1”, etc. The custom resources are served under this version at `/apis/<group>/<version>/...` if `served` is true.
    schema
    CustomResourceValidation
    schema describes the schema used for validation and pruning of this version of the custom resource. Top-level and per-version schemas are mutually exclusive. Per-version schemas must not all be set to identical values (top-level validation schema should be used instead).
    served
    boolean
    served is a flag enabling/disabling this version from being served via REST APIs
    storage
    boolean
    storage indicates this version should be used when persisting custom resources to storage. There must be exactly one version with storage=true.
    subresources
    CustomResourceSubresources
    subresources specify what subresources this version of the defined custom resource have. Top-level and per-version subresources are mutually exclusive. Per-version subresources must not all be set to identical values (top-level subresources should be used instead).
    +

    CustomResourceSubresourceScale v1beta1 apiextensions.k8s.io

    + + + + + +
    GroupVersionKind
    apiextensions.k8s.iov1beta1CustomResourceSubresourceScale
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + + +
    FieldDescription
    labelSelectorPath
    string
    labelSelectorPath defines the JSON path inside of a custom resource that corresponds to Scale `status.selector`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.status` or `.spec`. Must be set to work with HorizontalPodAutoscaler. The field pointed by this JSON path must be a string field (not a complex selector struct) which contains a serialized label selector in string form. More info: https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions#scale-subresource If there is no value under the given path in the custom resource, the `status.selector` value in the `/scale` subresource will default to the empty string.
    specReplicasPath
    string
    specReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale `spec.replicas`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.spec`. If there is no value under the given path in the custom resource, the `/scale` subresource will return an error on GET.
    statusReplicasPath
    string
    statusReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale `status.replicas`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.status`. If there is no value under the given path in the custom resource, the `status.replicas` value in the `/scale` subresource will default to 0.
    +

    CustomResourceSubresourceStatus v1beta1 apiextensions.k8s.io

    + + + + + +
    GroupVersionKind
    apiextensions.k8s.iov1beta1CustomResourceSubresourceStatus
    +
    Other API versions of this object exist: +v1 +
    + + + + + +
    FieldDescription
    +

    CustomResourceSubresources v1beta1 apiextensions.k8s.io

    + + + + + +
    GroupVersionKind
    apiextensions.k8s.iov1beta1CustomResourceSubresources
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + +
    FieldDescription
    scale
    CustomResourceSubresourceScale
    scale indicates the custom resource should serve a `/scale` subresource that returns an `autoscaling/v1` Scale object.
    status
    CustomResourceSubresourceStatus
    status indicates the custom resource should serve a `/status` subresource. When enabled: 1. requests to the custom resource primary endpoint ignore changes to the `status` stanza of the object. 2. requests to the custom resource `/status` subresource ignore changes to anything other than the `status` stanza of the object.
    +

    CustomResourceValidation v1beta1 apiextensions.k8s.io

    + + + + + +
    GroupVersionKind
    apiextensions.k8s.iov1beta1CustomResourceValidation
    +
    Other API versions of this object exist: +v1 +
    + + + + + + +
    FieldDescription
    openAPIV3Schema
    JSONSchemaProps
    openAPIV3Schema is the OpenAPI v3 schema to use for validation and pruning.
    +

    Endpoint v1beta1 discovery.k8s.io

    + + + + + +
    GroupVersionKind
    discovery.k8s.iov1beta1Endpoint
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + + + + + + +
    FieldDescription
    addresses
    string array
    addresses of this endpoint. The contents of this field are interpreted according to the corresponding EndpointSlice addressType field. Consumers must handle different types of addresses in the context of their own capabilities. This must contain at least one address but no more than 100.
    conditions
    EndpointConditions
    conditions contains information about the current status of the endpoint.
    hints
    EndpointHints
    hints contains information associated with how an endpoint should be consumed.
    hostname
    string
    hostname of this endpoint. This field may be used by consumers of endpoints to distinguish endpoints from each other (e.g. in DNS names). Multiple endpoints which use the same hostname should be considered fungible (e.g. multiple A values in DNS). Must be lowercase and pass DNS Label (RFC 1123) validation.
    nodeName
    string
    nodeName represents the name of the Node hosting this endpoint. This can be used to determine endpoints local to a Node. This field can be enabled with the EndpointSliceNodeName feature gate.
    targetRef
    ObjectReference
    targetRef is a reference to a Kubernetes object that represents this endpoint.
    topology
    object
    topology contains arbitrary topology information associated with the endpoint. These key/value pairs must conform with the label format. https://kubernetes.io/docs/concepts/overview/working-with-objects/labels Topology may include a maximum of 16 key/value pairs. This includes, but is not limited to the following well known keys: * kubernetes.io/hostname: the value indicates the hostname of the node where the endpoint is located. This should match the corresponding node label. * topology.kubernetes.io/zone: the value indicates the zone where the endpoint is located. This should match the corresponding node label. * topology.kubernetes.io/region: the value indicates the region where the endpoint is located. This should match the corresponding node label. This field is deprecated and will be removed in future api versions.
    +

    EndpointConditions v1beta1 discovery.k8s.io

    + + + + + +
    GroupVersionKind
    discovery.k8s.iov1beta1EndpointConditions
    +
    Other API versions of this object exist: +v1 +
    +
    Appears In: + +
    + + + + + + + +
    FieldDescription
    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.
    serving
    boolean
    serving is identical to ready except that it is set regardless of the terminating state of endpoints. This condition should be set to true for a ready endpoint that is terminating. If nil, consumers should defer to the ready condition. This field can be enabled with the EndpointSliceTerminatingCondition feature gate.
    terminating
    boolean
    terminating indicates that this endpoint is terminating. A nil value indicates an unknown state. Consumers should interpret this unknown state to mean that the endpoint is not terminating. This field can be enabled with the EndpointSliceTerminatingCondition feature gate.
    +

    EndpointHints v1beta1 discovery.k8s.io

    + + + + + +
    GroupVersionKind
    discovery.k8s.iov1beta1EndpointHints
    +
    Other API versions of this object exist: +v1 +
    +
    Appears In: + +
    + + + + + +
    FieldDescription
    forZones
    ForZone array
    forZones indicates the zone(s) this endpoint should be consumed by to enable topology aware routing. May contain a maximum of 8 entries.
    +

    EndpointPort v1 discovery.k8s.io

    + + + + + +
    GroupVersionKind
    discovery.k8s.iov1EndpointPort
    +
    Other API versions of this object exist: +v1beta1 +
    +
    Appears In: + +
    + + + + + + + + +
    FieldDescription
    appProtocol
    string
    The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol.
    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.
    port
    integer
    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.
    protocol
    string
    The IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP.
    +

    EndpointPort v1beta1 discovery.k8s.io

    + + + + + +
    GroupVersionKind
    discovery.k8s.iov1beta1EndpointPort
    +
    Other API versions of this object exist: +v1 +v1 +
    + + + + + + + + + +
    FieldDescription
    appProtocol
    string
    The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol.
    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.
    port
    integer
    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.
    protocol
    string
    The IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP.
    +

    EndpointSlice v1beta1 discovery.k8s.io

    + + + + + +
    GroupVersionKind
    discovery.k8s.iov1beta1EndpointSlice
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + + + + + +
    FieldDescription
    addressType
    string
    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.
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    endpoints
    Endpoint array
    endpoints is a list of unique endpoints in this slice. Each slice may include a maximum of 1000 endpoints.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata.
    ports
    EndpointPort array
    ports specifies the list of network ports exposed by each endpoint in this slice. Each port must have a unique name. When ports is empty, it indicates that there are no defined ports. When a port is defined with a nil port value, it indicates "all ports". Each slice may include a maximum of 100 ports.
    +

    EndpointSliceList v1beta1 discovery

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    EndpointSlice array
    List of endpoint slices
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata.
    +

    Write Operations

    +

    Create

    +

    create an EndpointSlice

    +

    HTTP Request

    +POST /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    EndpointSlice
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    EndpointSlice
    OK
    201
    EndpointSlice
    Created
    202
    EndpointSlice
    Accepted
    +

    Patch

    +

    partially update the specified EndpointSlice

    +

    HTTP Request

    +PATCH /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the EndpointSlice
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    EndpointSlice
    OK
    +

    Replace

    +

    replace the specified EndpointSlice

    +

    HTTP Request

    +PUT /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the EndpointSlice
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    EndpointSlice
    +

    Response

    + + + + + + +
    CodeDescription
    200
    EndpointSlice
    OK
    201
    EndpointSlice
    Created
    +

    Delete

    +

    delete an EndpointSlice

    +

    HTTP Request

    +DELETE /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the EndpointSlice
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of EndpointSlice

    +

    HTTP Request

    +DELETE /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified EndpointSlice

    +

    HTTP Request

    +GET /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the EndpointSlice
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    EndpointSlice
    OK
    +

    List

    +

    list or watch objects of kind EndpointSlice

    +

    HTTP Request

    +GET /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    EndpointSliceList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind EndpointSlice

    +

    HTTP Request

    +GET /apis/discovery.k8s.io/v1beta1/endpointslices +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    EndpointSliceList
    OK
    +

    Watch

    +

    watch changes to an object of kind EndpointSlice. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/discovery.k8s.io/v1beta1/watch/namespaces/{namespace}/endpointslices/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the EndpointSlice
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of EndpointSlice. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/discovery.k8s.io/v1beta1/watch/namespaces/{namespace}/endpointslices +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of EndpointSlice. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/discovery.k8s.io/v1beta1/watch/endpointslices +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Event v1 events.k8s.io

    + + + + + +
    GroupVersionKind
    events.k8s.iov1Event
    +
    Other API versions of this object exist: +v1beta1 +
    +
    Appears In: + +
    + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    action
    string
    action is what action was taken/failed regarding to the regarding object. It is machine-readable. This field cannot be empty for new Events and it can have at most 128 characters.
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    deprecatedCount
    integer
    deprecatedCount is the deprecated field assuring backward compatibility with core.v1 Event type.
    deprecatedFirstTimestamp
    Time
    deprecatedFirstTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type.
    deprecatedLastTimestamp
    Time
    deprecatedLastTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type.
    deprecatedSource
    EventSource
    deprecatedSource is the deprecated field assuring backward compatibility with core.v1 Event type.
    eventTime
    MicroTime
    eventTime is the time when this Event was first observed. It is required.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    note
    string
    note is a human-readable description of the status of this operation. Maximal length of the note is 1kB, but libraries should be prepared to handle values up to 64kB.
    reason
    string
    reason is why the action was taken. It is human-readable. This field cannot be empty for new Events and it can have at most 128 characters.
    regarding
    ObjectReference
    regarding contains the object this Event is about. In most cases it's an Object reporting controller implements, e.g. ReplicaSetController implements ReplicaSets and this event is emitted because it acts on some changes in a ReplicaSet object.
    related
    ObjectReference
    related is the optional secondary object for more complex actions. E.g. when regarding object triggers a creation or deletion of related object.
    reportingController
    string
    reportingController is the name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`. This field cannot be empty for new Events.
    reportingInstance
    string
    reportingInstance is the ID of the controller instance, e.g. `kubelet-xyzf`. This field cannot be empty for new Events and it can have at most 128 characters.
    series
    EventSeries
    series is data about the Event series this event represents or nil if it's a singleton Event.
    type
    string
    type is the type of this event (Normal, Warning), new types could be added in the future. It is machine-readable. This field cannot be empty for new Events.
    +

    EventList v1 events

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    Event array
    items is a list of schema objects.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    +

    Write Operations

    +

    Create

    +

    create an Event

    +

    HTTP Request

    +POST /apis/events.k8s.io/v1/namespaces/{namespace}/events +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Event
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    Event
    OK
    201
    Event
    Created
    202
    Event
    Accepted
    +

    Patch

    +

    partially update the specified Event

    +

    HTTP Request

    +PATCH /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Event
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    Event
    OK
    +

    Replace

    +

    replace the specified Event

    +

    HTTP Request

    +PUT /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Event
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Event
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Event
    OK
    201
    Event
    Created
    +

    Delete

    +

    delete an Event

    +

    HTTP Request

    +DELETE /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Event
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of Event

    +

    HTTP Request

    +DELETE /apis/events.k8s.io/v1/namespaces/{namespace}/events +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified Event

    +

    HTTP Request

    +GET /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Event
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    Event
    OK
    +

    List

    +

    list or watch objects of kind Event

    +

    HTTP Request

    +GET /apis/events.k8s.io/v1/namespaces/{namespace}/events +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    EventList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind Event

    +

    HTTP Request

    +GET /apis/events.k8s.io/v1/events +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    EventList
    OK
    +

    Watch

    +

    watch changes to an object of kind Event. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/events.k8s.io/v1/watch/namespaces/{namespace}/events/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Event
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/events.k8s.io/v1/watch/namespaces/{namespace}/events +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/events.k8s.io/v1/watch/events +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Event v1beta1 events.k8s.io

    + + + + + +
    GroupVersionKind
    events.k8s.iov1beta1Event
    +
    Other API versions of this object exist: +v1 +v1 +
    +
    Appears In: + +
    + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    action
    string
    action is what action was taken/failed regarding to the regarding object. It is machine-readable. This field can have at most 128 characters.
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    deprecatedCount
    integer
    deprecatedCount is the deprecated field assuring backward compatibility with core.v1 Event type.
    deprecatedFirstTimestamp
    Time
    deprecatedFirstTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type.
    deprecatedLastTimestamp
    Time
    deprecatedLastTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type.
    deprecatedSource
    EventSource
    deprecatedSource is the deprecated field assuring backward compatibility with core.v1 Event type.
    eventTime
    MicroTime
    eventTime is the time when this Event was first observed. It is required.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    note
    string
    note is a human-readable description of the status of this operation. Maximal length of the note is 1kB, but libraries should be prepared to handle values up to 64kB.
    reason
    string
    reason is why the action was taken. It is human-readable. This field can have at most 128 characters.
    regarding
    ObjectReference
    regarding contains the object this Event is about. In most cases it's an Object reporting controller implements, e.g. ReplicaSetController implements ReplicaSets and this event is emitted because it acts on some changes in a ReplicaSet object.
    related
    ObjectReference
    related is the optional secondary object for more complex actions. E.g. when regarding object triggers a creation or deletion of related object.
    reportingController
    string
    reportingController is the name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`. This field cannot be empty for new Events.
    reportingInstance
    string
    reportingInstance is the ID of the controller instance, e.g. `kubelet-xyzf`. This field cannot be empty for new Events and it can have at most 128 characters.
    series
    EventSeries
    series is data about the Event series this event represents or nil if it's a singleton Event.
    type
    string
    type is the type of this event (Normal, Warning), new types could be added in the future. It is machine-readable.
    +

    EventList v1beta1 events

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    Event array
    items is a list of schema objects.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    +

    Write Operations

    +

    Create

    +

    create an Event

    +

    HTTP Request

    +POST /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Event
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    Event
    OK
    201
    Event
    Created
    202
    Event
    Accepted
    +

    Patch

    +

    partially update the specified Event

    +

    HTTP Request

    +PATCH /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Event
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    Event
    OK
    +

    Replace

    +

    replace the specified Event

    +

    HTTP Request

    +PUT /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Event
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Event
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Event
    OK
    201
    Event
    Created
    +

    Delete

    +

    delete an Event

    +

    HTTP Request

    +DELETE /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Event
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of Event

    +

    HTTP Request

    +DELETE /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified Event

    +

    HTTP Request

    +GET /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Event
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    Event
    OK
    +

    List

    +

    list or watch objects of kind Event

    +

    HTTP Request

    +GET /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    EventList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind Event

    +

    HTTP Request

    +GET /apis/events.k8s.io/v1beta1/events +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    EventList
    OK
    +

    Watch

    +

    watch changes to an object of kind Event. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/events.k8s.io/v1beta1/watch/namespaces/{namespace}/events/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Event
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/events.k8s.io/v1beta1/watch/namespaces/{namespace}/events +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/events.k8s.io/v1beta1/watch/events +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    EventSeries v1 events.k8s.io

    + + + + + +
    GroupVersionKind
    events.k8s.iov1EventSeries
    +
    Other API versions of this object exist: +v1beta1 +
    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    count
    integer
    count is the number of occurrences in this series up to the last heartbeat time.
    lastObservedTime
    MicroTime
    lastObservedTime is the time when last Event from the series was seen before last heartbeat.
    +

    EventSeries v1beta1 events.k8s.io

    + + + + + +
    GroupVersionKind
    events.k8s.iov1beta1EventSeries
    +
    Other API versions of this object exist: +v1 +v1 +
    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    count
    integer
    count is the number of occurrences in this series up to the last heartbeat time.
    lastObservedTime
    MicroTime
    lastObservedTime is the time when last Event from the series was seen before last heartbeat.
    +

    ExternalDocumentation v1beta1 apiextensions.k8s.io

    + + + + + +
    GroupVersionKind
    apiextensions.k8s.iov1beta1ExternalDocumentation
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + +
    FieldDescription
    description
    string
    url
    string
    +

    ExternalMetricSource v2beta1 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta1ExternalMetricSource
    +
    Other API versions of this object exist: +v2beta2 +
    + + + + + + + + + +
    FieldDescription
    metricName
    string
    metricName is the name of the metric in question.
    metricSelector
    LabelSelector
    metricSelector is used to identify a specific time series within a given metric.
    targetAverageValue
    Quantity
    targetAverageValue is the target per-pod value of global metric (as a quantity). Mutually exclusive with TargetValue.
    targetValue
    Quantity
    targetValue is the target value of the metric (as a quantity). Mutually exclusive with TargetAverageValue.
    +

    ExternalMetricStatus v2beta1 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta1ExternalMetricStatus
    +
    Other API versions of this object exist: +v2beta2 +
    + + + + + + + + + +
    FieldDescription
    currentAverageValue
    Quantity
    currentAverageValue is the current value of metric averaged over autoscaled pods.
    currentValue
    Quantity
    currentValue is the current value of the metric (as a quantity)
    metricName
    string
    metricName is the name of a metric used for autoscaling in metric system.
    metricSelector
    LabelSelector
    metricSelector is used to identify a specific time series within a given metric.
    +

    ForZone v1beta1 discovery.k8s.io

    + + + + + +
    GroupVersionKind
    discovery.k8s.iov1beta1ForZone
    +
    Other API versions of this object exist: +v1 +
    + + + + + + +
    FieldDescription
    name
    string
    name represents the name of the zone.
    +

    HTTPIngressPath v1beta1 extensions

    + + + + + +
    GroupVersionKind
    extensionsv1beta1HTTPIngressPath
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + + +
    FieldDescription
    backend
    IngressBackend
    Backend defines the referenced service endpoint to which the traffic will be forwarded to.
    path
    string
    Path is matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional "path" part of a URL as defined by RFC 3986. Paths must begin with a '/'. When unspecified, all paths from incoming requests are matched.
    pathType
    string
    PathType determines the interpretation of the Path matching. PathType can be one of the following values: * Exact: Matches the URL path exactly. * Prefix: Matches based on a URL path prefix split by '/'. Matching is done on a path element by element basis. A path element refers is the list of labels in the path split by the '/' separator. A request is a match for path p if every p is an element-wise prefix of p of the request path. Note that if the last element of the path is a substring of the last element in request path, it is not a match (e.g. /foo/bar matches /foo/bar/baz, but does not match /foo/barbaz). * ImplementationSpecific: Interpretation of the Path matching is up to the IngressClass. Implementations can treat this as a separate PathType or treat it identically to Prefix or Exact path types. Implementations are required to support all path types. Defaults to ImplementationSpecific.
    +

    HTTPIngressPath v1beta1 networking.k8s.io

    + + + + + +
    GroupVersionKind
    networking.k8s.iov1beta1HTTPIngressPath
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + + +
    FieldDescription
    backend
    IngressBackend
    Backend defines the referenced service endpoint to which the traffic will be forwarded to.
    path
    string
    Path is matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional "path" part of a URL as defined by RFC 3986. Paths must begin with a '/'. When unspecified, all paths from incoming requests are matched.
    pathType
    string
    PathType determines the interpretation of the Path matching. PathType can be one of the following values: * Exact: Matches the URL path exactly. * Prefix: Matches based on a URL path prefix split by '/'. Matching is done on a path element by element basis. A path element refers is the list of labels in the path split by the '/' separator. A request is a match for path p if every p is an element-wise prefix of p of the request path. Note that if the last element of the path is a substring of the last element in request path, it is not a match (e.g. /foo/bar matches /foo/bar/baz, but does not match /foo/barbaz). * ImplementationSpecific: Interpretation of the Path matching is up to the IngressClass. Implementations can treat this as a separate PathType or treat it identically to Prefix or Exact path types. Implementations are required to support all path types. Defaults to ImplementationSpecific.
    +

    HTTPIngressRuleValue v1beta1 extensions

    + + + + + +
    GroupVersionKind
    extensionsv1beta1HTTPIngressRuleValue
    +
    Other API versions of this object exist: +v1 +
    + + + + + + +
    FieldDescription
    paths
    HTTPIngressPath array
    A collection of paths that map requests to backends.
    +

    HTTPIngressRuleValue v1beta1 networking.k8s.io

    + + + + + +
    GroupVersionKind
    networking.k8s.iov1beta1HTTPIngressRuleValue
    +
    Other API versions of this object exist: +v1 +
    + + + + + + +
    FieldDescription
    paths
    HTTPIngressPath array
    A collection of paths that map requests to backends.
    +

    HorizontalPodAutoscaler v2beta2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta2HorizontalPodAutoscaler
    +
    Other API versions of this object exist: +v1 +v2beta1 +
    + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    spec
    HorizontalPodAutoscalerSpec
    spec is the specification for the behaviour of the autoscaler. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status.
    status
    HorizontalPodAutoscalerStatus
    status is the current information about the autoscaler.
    +

    HorizontalPodAutoscalerSpec v2beta2 autoscaling

    + + + + + + + + + + +
    FieldDescription
    behavior
    HorizontalPodAutoscalerBehavior
    behavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively). If not set, the default HPAScalingRules for scale up and scale down are used.
    maxReplicas
    integer
    maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas.
    metrics
    MetricSpec array
    metrics contains the specifications for which to use to calculate the desired replica count (the maximum replica count across all metrics will be used). The desired replica count is calculated multiplying the ratio between the target value and the current value by the current number of pods. Ergo, metrics used must decrease as the pod count is increased, and vice-versa. See the individual metric source types for more information about how each type of metric must respond. If not set, the default metric will be set to 80% average CPU utilization.
    minReplicas
    integer
    minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod. minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured. Scaling is active as long as at least one metric value is available.
    scaleTargetRef
    CrossVersionObjectReference
    scaleTargetRef points to the target resource to scale, and is used to the pods for which metrics should be collected, as well as to actually change the replica count.
    +

    HorizontalPodAutoscalerStatus v2beta2 autoscaling

    + + + + + + + + + + + +
    FieldDescription
    conditions
    HorizontalPodAutoscalerCondition array
    conditions is the set of conditions required for this autoscaler to scale its target, and indicates whether or not those conditions are met.
    currentMetrics
    MetricStatus array
    currentMetrics is the last read state of the metrics used by this autoscaler.
    currentReplicas
    integer
    currentReplicas is current number of replicas of pods managed by this autoscaler, as last seen by the autoscaler.
    desiredReplicas
    integer
    desiredReplicas is the desired number of replicas of pods managed by this autoscaler, as last calculated by the autoscaler.
    lastScaleTime
    Time
    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.
    observedGeneration
    integer
    observedGeneration is the most recent generation observed by this autoscaler.
    +

    HorizontalPodAutoscalerList v2beta2 autoscaling

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    HorizontalPodAutoscaler array
    items is the list of horizontal pod autoscaler objects.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    metadata is the standard list metadata.
    +

    Write Operations

    +

    Create

    +

    create a HorizontalPodAutoscaler

    +

    HTTP Request

    +POST /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    HorizontalPodAutoscaler
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    HorizontalPodAutoscaler
    OK
    201
    HorizontalPodAutoscaler
    Created
    202
    HorizontalPodAutoscaler
    Accepted
    +

    Patch

    +

    partially update the specified HorizontalPodAutoscaler

    +

    HTTP Request

    +PATCH /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the HorizontalPodAutoscaler
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    HorizontalPodAutoscaler
    OK
    +

    Replace

    +

    replace the specified HorizontalPodAutoscaler

    +

    HTTP Request

    +PUT /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the HorizontalPodAutoscaler
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    HorizontalPodAutoscaler
    +

    Response

    + + + + + + +
    CodeDescription
    200
    HorizontalPodAutoscaler
    OK
    201
    HorizontalPodAutoscaler
    Created
    +

    Delete

    +

    delete a HorizontalPodAutoscaler

    +

    HTTP Request

    +DELETE /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the HorizontalPodAutoscaler
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of HorizontalPodAutoscaler

    +

    HTTP Request

    +DELETE /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified HorizontalPodAutoscaler

    +

    HTTP Request

    +GET /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the HorizontalPodAutoscaler
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    HorizontalPodAutoscaler
    OK
    +

    List

    +

    list or watch objects of kind HorizontalPodAutoscaler

    +

    HTTP Request

    +GET /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    HorizontalPodAutoscalerList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind HorizontalPodAutoscaler

    +

    HTTP Request

    +GET /apis/autoscaling/v2beta2/horizontalpodautoscalers +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    HorizontalPodAutoscalerList
    OK
    +

    Watch

    +

    watch changes to an object of kind HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/autoscaling/v2beta2/watch/namespaces/{namespace}/horizontalpodautoscalers/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the HorizontalPodAutoscaler
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/autoscaling/v2beta2/watch/namespaces/{namespace}/horizontalpodautoscalers +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/autoscaling/v2beta2/watch/horizontalpodautoscalers +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Status Operations

    +

    Patch Status

    +

    partially update status of the specified HorizontalPodAutoscaler

    +

    HTTP Request

    +PATCH /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the HorizontalPodAutoscaler
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    HorizontalPodAutoscaler
    OK
    +

    Read Status

    +

    read status of the specified HorizontalPodAutoscaler

    +

    HTTP Request

    +GET /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the HorizontalPodAutoscaler
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    HorizontalPodAutoscaler
    OK
    +

    Replace Status

    +

    replace status of the specified HorizontalPodAutoscaler

    +

    HTTP Request

    +PUT /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the HorizontalPodAutoscaler
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    HorizontalPodAutoscaler
    +

    Response

    + + + + + + +
    CodeDescription
    200
    HorizontalPodAutoscaler
    OK
    201
    HorizontalPodAutoscaler
    Created
    +

    HorizontalPodAutoscaler v2beta1 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta1HorizontalPodAutoscaler
    +
    Other API versions of this object exist: +v1 +v2beta2 +
    + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    spec
    HorizontalPodAutoscalerSpec
    spec is the specification for the behaviour of the autoscaler. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status.
    status
    HorizontalPodAutoscalerStatus
    status is the current information about the autoscaler.
    +

    HorizontalPodAutoscalerSpec v2beta1 autoscaling

    + + + + + + + + + +
    FieldDescription
    maxReplicas
    integer
    maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas.
    metrics
    MetricSpec array
    metrics contains the specifications for which to use to calculate the desired replica count (the maximum replica count across all metrics will be used). The desired replica count is calculated multiplying the ratio between the target value and the current value by the current number of pods. Ergo, metrics used must decrease as the pod count is increased, and vice-versa. See the individual metric source types for more information about how each type of metric must respond.
    minReplicas
    integer
    minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod. minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured. Scaling is active as long as at least one metric value is available.
    scaleTargetRef
    CrossVersionObjectReference
    scaleTargetRef points to the target resource to scale, and is used to the pods for which metrics should be collected, as well as to actually change the replica count.
    +

    HorizontalPodAutoscalerStatus v2beta1 autoscaling

    + + + + + + + + + + + +
    FieldDescription
    conditions
    HorizontalPodAutoscalerCondition array
    conditions is the set of conditions required for this autoscaler to scale its target, and indicates whether or not those conditions are met.
    currentMetrics
    MetricStatus array
    currentMetrics is the last read state of the metrics used by this autoscaler.
    currentReplicas
    integer
    currentReplicas is current number of replicas of pods managed by this autoscaler, as last seen by the autoscaler.
    desiredReplicas
    integer
    desiredReplicas is the desired number of replicas of pods managed by this autoscaler, as last calculated by the autoscaler.
    lastScaleTime
    Time
    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.
    observedGeneration
    integer
    observedGeneration is the most recent generation observed by this autoscaler.
    +

    HorizontalPodAutoscalerList v2beta1 autoscaling

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    HorizontalPodAutoscaler array
    items is the list of horizontal pod autoscaler objects.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    metadata is the standard list metadata.
    +

    Write Operations

    +

    Create

    +

    create a HorizontalPodAutoscaler

    +

    HTTP Request

    +POST /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    HorizontalPodAutoscaler
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    HorizontalPodAutoscaler
    OK
    201
    HorizontalPodAutoscaler
    Created
    202
    HorizontalPodAutoscaler
    Accepted
    +

    Patch

    +

    partially update the specified HorizontalPodAutoscaler

    +

    HTTP Request

    +PATCH /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the HorizontalPodAutoscaler
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    HorizontalPodAutoscaler
    OK
    +

    Replace

    +

    replace the specified HorizontalPodAutoscaler

    +

    HTTP Request

    +PUT /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the HorizontalPodAutoscaler
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    HorizontalPodAutoscaler
    +

    Response

    + + + + + + +
    CodeDescription
    200
    HorizontalPodAutoscaler
    OK
    201
    HorizontalPodAutoscaler
    Created
    +

    Delete

    +

    delete a HorizontalPodAutoscaler

    +

    HTTP Request

    +DELETE /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the HorizontalPodAutoscaler
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of HorizontalPodAutoscaler

    +

    HTTP Request

    +DELETE /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified HorizontalPodAutoscaler

    +

    HTTP Request

    +GET /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the HorizontalPodAutoscaler
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    HorizontalPodAutoscaler
    OK
    +

    List

    +

    list or watch objects of kind HorizontalPodAutoscaler

    +

    HTTP Request

    +GET /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    HorizontalPodAutoscalerList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind HorizontalPodAutoscaler

    +

    HTTP Request

    +GET /apis/autoscaling/v2beta1/horizontalpodautoscalers +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    HorizontalPodAutoscalerList
    OK
    +

    Watch

    +

    watch changes to an object of kind HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/autoscaling/v2beta1/watch/namespaces/{namespace}/horizontalpodautoscalers/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the HorizontalPodAutoscaler
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/autoscaling/v2beta1/watch/namespaces/{namespace}/horizontalpodautoscalers +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/autoscaling/v2beta1/watch/horizontalpodautoscalers +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Status Operations

    +

    Patch Status

    +

    partially update status of the specified HorizontalPodAutoscaler

    +

    HTTP Request

    +PATCH /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the HorizontalPodAutoscaler
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    HorizontalPodAutoscaler
    OK
    +

    Read Status

    +

    read status of the specified HorizontalPodAutoscaler

    +

    HTTP Request

    +GET /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the HorizontalPodAutoscaler
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    HorizontalPodAutoscaler
    OK
    +

    Replace Status

    +

    replace status of the specified HorizontalPodAutoscaler

    +

    HTTP Request

    +PUT /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the HorizontalPodAutoscaler
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    HorizontalPodAutoscaler
    +

    Response

    + + + + + + +
    CodeDescription
    200
    HorizontalPodAutoscaler
    OK
    201
    HorizontalPodAutoscaler
    Created
    +

    HorizontalPodAutoscalerCondition v2beta1 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta1HorizontalPodAutoscalerCondition
    +
    Other API versions of this object exist: +v2beta2 +
    + + + + + + + + + + +
    FieldDescription
    lastTransitionTime
    Time
    lastTransitionTime is the last time the condition transitioned from one status to another
    message
    string
    message is a human-readable explanation containing details about the transition
    reason
    string
    reason is the reason for the condition's last transition.
    status
    string
    status is the status of the condition (True, False, Unknown)
    type
    string
    type describes the current condition
    +

    Ingress v1beta1 extensions

    + + + + + +
    GroupVersionKind
    extensionsv1beta1Ingress
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    spec
    IngressSpec
    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
    IngressStatus
    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
    +

    IngressSpec v1beta1 extensions

    +
    Appears In: + +
    + + + + + + + + +
    FieldDescription
    backend
    IngressBackend
    A default backend capable of servicing requests that don't match any rule. At least one of 'backend' or 'rules' must be specified. This field is optional to allow the loadbalancer controller or defaulting logic to specify a global default.
    ingressClassName
    string
    IngressClassName is the name of the IngressClass cluster resource. The associated IngressClass defines which controller will implement the resource. This replaces the deprecated `kubernetes.io/ingress.class` annotation. For backwards compatibility, when that annotation is set, it must be given precedence over this field. The controller may emit a warning if the field and annotation have different values. Implementations of this API should ignore Ingresses without a class specified. An IngressClass resource may be marked as default, which can be used to set a default value for this field. For more information, refer to the IngressClass documentation.
    rules
    IngressRule array
    A list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend.
    tls
    IngressTLS array
    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.
    +

    IngressStatus v1beta1 extensions

    +
    Appears In: + +
    + + + + + +
    FieldDescription
    loadBalancer
    LoadBalancerStatus
    LoadBalancer contains the current status of the load-balancer.
    +

    IngressList v1beta1 extensions

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    Ingress array
    Items is the list of Ingress.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    +

    Write Operations

    +

    Create

    +

    create an Ingress

    +

    HTTP Request

    +POST /apis/extensions/v1beta1/namespaces/{namespace}/ingresses +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Ingress
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    Ingress
    OK
    201
    Ingress
    Created
    202
    Ingress
    Accepted
    +

    Patch

    +

    partially update the specified Ingress

    +

    HTTP Request

    +PATCH /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Ingress
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    Ingress
    OK
    +

    Replace

    +

    replace the specified Ingress

    +

    HTTP Request

    +PUT /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Ingress
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Ingress
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Ingress
    OK
    201
    Ingress
    Created
    +

    Delete

    +

    delete an Ingress

    +

    HTTP Request

    +DELETE /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Ingress
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of Ingress

    +

    HTTP Request

    +DELETE /apis/extensions/v1beta1/namespaces/{namespace}/ingresses +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified Ingress

    +

    HTTP Request

    +GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Ingress
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    Ingress
    OK
    +

    List

    +

    list or watch objects of kind Ingress

    +

    HTTP Request

    +GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    IngressList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind Ingress

    +

    HTTP Request

    +GET /apis/extensions/v1beta1/ingresses +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    IngressList
    OK
    +

    Watch

    +

    watch changes to an object of kind Ingress. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/ingresses/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Ingress
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of Ingress. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/ingresses +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of Ingress. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/extensions/v1beta1/watch/ingresses +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Status Operations

    +

    Patch Status

    +

    partially update status of the specified Ingress

    +

    HTTP Request

    +PATCH /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Ingress
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    Ingress
    OK
    +

    Read Status

    +

    read status of the specified Ingress

    +

    HTTP Request

    +GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Ingress
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    Ingress
    OK
    +

    Replace Status

    +

    replace status of the specified Ingress

    +

    HTTP Request

    +PUT /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Ingress
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Ingress
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Ingress
    OK
    201
    Ingress
    Created
    +

    Ingress v1beta1 networking.k8s.io

    + + + + + +
    GroupVersionKind
    networking.k8s.iov1beta1Ingress
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    spec
    IngressSpec
    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
    IngressStatus
    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
    +

    IngressSpec v1beta1 networking

    +
    Appears In: + +
    + + + + + + + + +
    FieldDescription
    backend
    IngressBackend
    A default backend capable of servicing requests that don't match any rule. At least one of 'backend' or 'rules' must be specified. This field is optional to allow the loadbalancer controller or defaulting logic to specify a global default.
    ingressClassName
    string
    IngressClassName is the name of the IngressClass cluster resource. The associated IngressClass defines which controller will implement the resource. This replaces the deprecated `kubernetes.io/ingress.class` annotation. For backwards compatibility, when that annotation is set, it must be given precedence over this field. The controller may emit a warning if the field and annotation have different values. Implementations of this API should ignore Ingresses without a class specified. An IngressClass resource may be marked as default, which can be used to set a default value for this field. For more information, refer to the IngressClass documentation.
    rules
    IngressRule array
    A list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend.
    tls
    IngressTLS array
    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.
    +

    IngressStatus v1beta1 networking

    +
    Appears In: + +
    + + + + + +
    FieldDescription
    loadBalancer
    LoadBalancerStatus
    LoadBalancer contains the current status of the load-balancer.
    +

    IngressList v1beta1 networking

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    Ingress array
    Items is the list of Ingress.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    +

    Write Operations

    +

    Create

    +

    create an Ingress

    +

    HTTP Request

    +POST /apis/networking.k8s.io/v1beta1/namespaces/{namespace}/ingresses +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Ingress
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    Ingress
    OK
    201
    Ingress
    Created
    202
    Ingress
    Accepted
    +

    Patch

    +

    partially update the specified Ingress

    +

    HTTP Request

    +PATCH /apis/networking.k8s.io/v1beta1/namespaces/{namespace}/ingresses/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Ingress
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    Ingress
    OK
    +

    Replace

    +

    replace the specified Ingress

    +

    HTTP Request

    +PUT /apis/networking.k8s.io/v1beta1/namespaces/{namespace}/ingresses/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Ingress
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Ingress
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Ingress
    OK
    201
    Ingress
    Created
    +

    Delete

    +

    delete an Ingress

    +

    HTTP Request

    +DELETE /apis/networking.k8s.io/v1beta1/namespaces/{namespace}/ingresses/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Ingress
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of Ingress

    +

    HTTP Request

    +DELETE /apis/networking.k8s.io/v1beta1/namespaces/{namespace}/ingresses +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified Ingress

    +

    HTTP Request

    +GET /apis/networking.k8s.io/v1beta1/namespaces/{namespace}/ingresses/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Ingress
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    Ingress
    OK
    +

    List

    +

    list or watch objects of kind Ingress

    +

    HTTP Request

    +GET /apis/networking.k8s.io/v1beta1/namespaces/{namespace}/ingresses +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    IngressList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind Ingress

    +

    HTTP Request

    +GET /apis/networking.k8s.io/v1beta1/ingresses +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    IngressList
    OK
    +

    Watch

    +

    watch changes to an object of kind Ingress. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/networking.k8s.io/v1beta1/watch/namespaces/{namespace}/ingresses/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Ingress
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of Ingress. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/networking.k8s.io/v1beta1/watch/namespaces/{namespace}/ingresses +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of Ingress. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/networking.k8s.io/v1beta1/watch/ingresses +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Status Operations

    +

    Patch Status

    +

    partially update status of the specified Ingress

    +

    HTTP Request

    +PATCH /apis/networking.k8s.io/v1beta1/namespaces/{namespace}/ingresses/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Ingress
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    Ingress
    OK
    +

    Read Status

    +

    read status of the specified Ingress

    +

    HTTP Request

    +GET /apis/networking.k8s.io/v1beta1/namespaces/{namespace}/ingresses/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Ingress
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    Ingress
    OK
    +

    Replace Status

    +

    replace status of the specified Ingress

    +

    HTTP Request

    +PUT /apis/networking.k8s.io/v1beta1/namespaces/{namespace}/ingresses/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Ingress
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Ingress
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Ingress
    OK
    201
    Ingress
    Created
    +

    IngressBackend v1beta1 extensions

    + + + + + +
    GroupVersionKind
    extensionsv1beta1IngressBackend
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + + +
    FieldDescription
    resource
    TypedLocalObjectReference
    Resource is an ObjectRef to another Kubernetes resource in the namespace of the Ingress object. If resource is specified, serviceName and servicePort must not be specified.
    serviceName
    string
    Specifies the name of the referenced service.
    servicePortSpecifies the port of the referenced service.
    +

    IngressBackend v1beta1 networking.k8s.io

    + + + + + +
    GroupVersionKind
    networking.k8s.iov1beta1IngressBackend
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + + +
    FieldDescription
    resource
    TypedLocalObjectReference
    Resource is an ObjectRef to another Kubernetes resource in the namespace of the Ingress object. If resource is specified, serviceName and servicePort must not be specified.
    serviceName
    string
    Specifies the name of the referenced service.
    servicePortSpecifies the port of the referenced service.
    +

    IngressClass v1beta1 networking.k8s.io

    + + + + + +
    GroupVersionKind
    networking.k8s.iov1beta1IngressClass
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    spec
    IngressClassSpec
    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
    +

    IngressClassSpec v1beta1 networking

    + + + + + + + +
    FieldDescription
    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.
    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.
    +

    IngressClassList v1beta1 networking

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    IngressClass array
    Items is the list of IngressClasses.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata.
    +

    Write Operations

    +

    Create

    +

    create an IngressClass

    +

    HTTP Request

    +POST /apis/networking.k8s.io/v1beta1/ingressclasses +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    IngressClass
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    IngressClass
    OK
    201
    IngressClass
    Created
    202
    IngressClass
    Accepted
    +

    Patch

    +

    partially update the specified IngressClass

    +

    HTTP Request

    +PATCH /apis/networking.k8s.io/v1beta1/ingressclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the IngressClass
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    IngressClass
    OK
    +

    Replace

    +

    replace the specified IngressClass

    +

    HTTP Request

    +PUT /apis/networking.k8s.io/v1beta1/ingressclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the IngressClass
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    IngressClass
    +

    Response

    + + + + + + +
    CodeDescription
    200
    IngressClass
    OK
    201
    IngressClass
    Created
    +

    Delete

    +

    delete an IngressClass

    +

    HTTP Request

    +DELETE /apis/networking.k8s.io/v1beta1/ingressclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the IngressClass
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of IngressClass

    +

    HTTP Request

    +DELETE /apis/networking.k8s.io/v1beta1/ingressclasses +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified IngressClass

    +

    HTTP Request

    +GET /apis/networking.k8s.io/v1beta1/ingressclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the IngressClass
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    IngressClass
    OK
    +

    List

    +

    list or watch objects of kind IngressClass

    +

    HTTP Request

    +GET /apis/networking.k8s.io/v1beta1/ingressclasses +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    IngressClassList
    OK
    +

    Watch

    +

    watch changes to an object of kind IngressClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/networking.k8s.io/v1beta1/watch/ingressclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the IngressClass
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of IngressClass. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/networking.k8s.io/v1beta1/watch/ingressclasses +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    IngressClassParametersReference v1beta1 networking.k8s.io

    + + + + + +
    GroupVersionKind
    networking.k8s.iov1beta1IngressClassParametersReference
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + + + + +
    FieldDescription
    apiGroup
    string
    APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
    kind
    string
    Kind is the type of resource being referenced.
    name
    string
    Name is the name of resource being referenced.
    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".
    scope
    string
    Scope represents if this refers to a cluster or namespace scoped resource. This may be set to "Cluster" (default) or "Namespace". Field can be enabled with IngressClassNamespacedParams feature gate.
    +

    IngressRule v1beta1 extensions

    + + + + + +
    GroupVersionKind
    extensionsv1beta1IngressRule
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + +
    FieldDescription
    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 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.
    http
    HTTPIngressRuleValue
    +

    IngressRule v1beta1 networking.k8s.io

    + + + + + +
    GroupVersionKind
    networking.k8s.iov1beta1IngressRule
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + +
    FieldDescription
    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 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.
    http
    HTTPIngressRuleValue
    +

    IngressTLS v1beta1 extensions

    + + + + + +
    GroupVersionKind
    extensionsv1beta1IngressTLS
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + +
    FieldDescription
    hosts
    string array
    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.
    secretName
    string
    SecretName is the name of the secret used to terminate SSL traffic on 443. Field is left optional to allow SSL 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.
    +

    IngressTLS v1beta1 networking.k8s.io

    + + + + + +
    GroupVersionKind
    networking.k8s.iov1beta1IngressTLS
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + +
    FieldDescription
    hosts
    string array
    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.
    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.
    +

    JSON v1beta1 apiextensions.k8s.io

    + + + + + +
    GroupVersionKind
    apiextensions.k8s.iov1beta1JSON
    +
    Other API versions of this object exist: +v1 +
    + + + + + +
    FieldDescription
    +

    JSONSchemaProps v1beta1 apiextensions.k8s.io

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

    JSONSchemaPropsOrArray v1beta1 apiextensions.k8s.io

    + + + + + +
    GroupVersionKind
    apiextensions.k8s.iov1beta1JSONSchemaPropsOrArray
    +
    Other API versions of this object exist: +v1 +
    + + + + + +
    FieldDescription
    +

    JSONSchemaPropsOrBool v1beta1 apiextensions.k8s.io

    + + + + + +
    GroupVersionKind
    apiextensions.k8s.iov1beta1JSONSchemaPropsOrBool
    +
    Other API versions of this object exist: +v1 +
    + + + + + +
    FieldDescription
    +

    JobTemplateSpec v1beta1 batch

    + + + + + +
    GroupVersionKind
    batchv1beta1JobTemplateSpec
    +
    Other API versions of this object exist: +v1 +
    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    metadata
    ObjectMeta
    Standard object's metadata of the jobs created from this template. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    spec
    JobSpec
    Specification of the desired behavior of the job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    +

    Lease v1beta1 coordination.k8s.io

    + + + + + +
    GroupVersionKind
    coordination.k8s.iov1beta1Lease
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    spec
    LeaseSpec
    Specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    +

    LeaseSpec v1beta1 coordination

    +
    Appears In: + +
    + + + + + + + + + +
    FieldDescription
    acquireTime
    MicroTime
    acquireTime is a time when the current lease was acquired.
    holderIdentity
    string
    holderIdentity contains the identity of the holder of a current lease.
    leaseDurationSeconds
    integer
    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
    integer
    leaseTransitions is the number of transitions of a lease between holders.
    renewTime
    MicroTime
    renewTime is a time when the current holder of a lease has last updated the lease.
    +

    LeaseList v1beta1 coordination

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    Lease array
    Items is a list of schema objects.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    +

    Write Operations

    +

    Create

    +

    create a Lease

    +

    HTTP Request

    +POST /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leases +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Lease
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    Lease
    OK
    201
    Lease
    Created
    202
    Lease
    Accepted
    +

    Patch

    +

    partially update the specified Lease

    +

    HTTP Request

    +PATCH /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leases/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Lease
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    Lease
    OK
    +

    Replace

    +

    replace the specified Lease

    +

    HTTP Request

    +PUT /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leases/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Lease
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Lease
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Lease
    OK
    201
    Lease
    Created
    +

    Delete

    +

    delete a Lease

    +

    HTTP Request

    +DELETE /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leases/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Lease
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of Lease

    +

    HTTP Request

    +DELETE /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leases +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified Lease

    +

    HTTP Request

    +GET /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leases/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Lease
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    Lease
    OK
    +

    List

    +

    list or watch objects of kind Lease

    +

    HTTP Request

    +GET /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leases +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    LeaseList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind Lease

    +

    HTTP Request

    +GET /apis/coordination.k8s.io/v1beta1/leases +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    LeaseList
    OK
    +

    Watch

    +

    watch changes to an object of kind Lease. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/coordination.k8s.io/v1beta1/watch/namespaces/{namespace}/leases/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Lease
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of Lease. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/coordination.k8s.io/v1beta1/watch/namespaces/{namespace}/leases +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of Lease. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/coordination.k8s.io/v1beta1/watch/leases +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    LocalSubjectAccessReview v1beta1 authorization.k8s.io

    + + + + + +
    GroupVersionKind
    authorization.k8s.iov1beta1LocalSubjectAccessReview
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    spec
    SubjectAccessReviewSpec
    Spec holds information about the request being evaluated. spec.namespace must be equal to the namespace you made the request against. If empty, it is defaulted.
    status
    SubjectAccessReviewStatus
    Status is filled in by the server and indicates whether the request is allowed or not
    +

    Write Operations

    +

    Create

    +

    create a LocalSubjectAccessReview

    +

    HTTP Request

    +POST /apis/authorization.k8s.io/v1beta1/namespaces/{namespace}/localsubjectaccessreviews +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    dryRunWhen 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
    fieldManagerfieldManager 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.
    prettyIf 'true', then the output is pretty printed.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    LocalSubjectAccessReview
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    LocalSubjectAccessReview
    OK
    201
    LocalSubjectAccessReview
    Created
    202
    LocalSubjectAccessReview
    Accepted
    +

    MetricSpec v2beta1 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta1MetricSpec
    +
    Other API versions of this object exist: +v2beta2 +
    + + + + + + + + + + + +
    FieldDescription
    containerResource
    ContainerResourceMetricSource
    container resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod of the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. This is an alpha feature and can be enabled by the HPAContainerMetrics feature flag.
    external
    ExternalMetricSource
    external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster).
    object
    ObjectMetricSource
    object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).
    pods
    PodsMetricSource
    pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value.
    resource
    ResourceMetricSource
    resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.
    type
    string
    type is the type of metric source. It should be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each mapping to a matching field in the object. Note: "ContainerResource" type is available on when the feature-gate HPAContainerMetrics is enabled
    +

    MetricStatus v2beta1 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta1MetricStatus
    +
    Other API versions of this object exist: +v2beta2 +
    + + + + + + + + + + + +
    FieldDescription
    containerResource
    ContainerResourceMetricStatus
    container resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.
    external
    ExternalMetricStatus
    external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster).
    object
    ObjectMetricStatus
    object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).
    pods
    PodsMetricStatus
    pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value.
    resource
    ResourceMetricStatus
    resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.
    type
    string
    type is the type of metric source. It will be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each corresponds to a matching field in the object. Note: "ContainerResource" type is available on when the feature-gate HPAContainerMetrics is enabled
    +

    MutatingWebhook v1beta1 admissionregistration.k8s.io

    + + + + + +
    GroupVersionKind
    admissionregistration.k8s.iov1beta1MutatingWebhook
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + + + + + + + + + + +
    FieldDescription
    admissionReviewVersions
    string array
    AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` versions the Webhook expects. API server will try to use first version in the list which it supports. If none of the versions specified in this list supported by API server, validation will fail for this object. If a persisted webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail and be subject to the failure policy. Default to `['v1beta1']`.
    clientConfig
    WebhookClientConfig
    ClientConfig defines how to communicate with the hook. Required
    failurePolicy
    string
    FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Ignore.
    matchPolicy
    string
    matchPolicy defines how the "rules" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". - Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the webhook. - Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the webhook. Defaults to "Exact"
    name
    string
    The name of the admission webhook. Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where "imagepolicy" is the name of the webhook, and kubernetes.io is the name of the organization. Required.
    namespaceSelector
    LabelSelector
    NamespaceSelector decides whether to run the webhook on an object based on whether the namespace for that object matches the selector. If the object itself is a namespace, the matching is performed on object.metadata.labels. If the object is another cluster scoped resource, it never skips the webhook. For example, to run the webhook on any objects whose namespace is not associated with "runlevel" of "0" or "1"; you will set the selector as follows: "namespaceSelector": { "matchExpressions": [ { "key": "runlevel", "operator": "NotIn", "values": [ "0", "1" ] } ] } If instead you want to only run the webhook on any objects whose namespace is associated with the "environment" of "prod" or "staging"; you will set the selector as follows: "namespaceSelector": { "matchExpressions": [ { "key": "environment", "operator": "In", "values": [ "prod", "staging" ] } ] } See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ for more examples of label selectors. Default to the empty LabelSelector, which matches everything.
    objectSelector
    LabelSelector
    ObjectSelector decides whether to run the webhook based on if the object has matching labels. objectSelector is evaluated against both the oldObject and newObject that would be sent to the webhook, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. Default to the empty LabelSelector, which matches everything.
    reinvocationPolicy
    string
    reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation. Allowed values are "Never" and "IfNeeded". Never: the webhook will not be called more than once in a single admission evaluation. IfNeeded: the webhook will be called at least one additional time as part of the admission evaluation if the object being admitted is modified by other admission plugins after the initial webhook call. Webhooks that specify this option *must* be idempotent, able to process objects they previously admitted. Note: * the number of additional invocations is not guaranteed to be exactly one. * if additional invocations result in further modifications to the object, webhooks are not guaranteed to be invoked again. * webhooks that use this option may be reordered to minimize the number of additional invocations. * to validate an object after all mutations are guaranteed complete, use a validating admission webhook instead. Defaults to "Never".
    rules
    RuleWithOperations array
    Rules describes what operations on what resources/subresources the webhook cares about. The webhook cares about an operation if it matches _any_ Rule. However, in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks from putting the cluster in a state which cannot be recovered from without completely disabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects.
    sideEffects
    string
    SideEffects states whether this webhook has side effects. Acceptable values are: Unknown, None, Some, NoneOnDryRun Webhooks with side effects MUST implement a reconciliation system, since a request may be rejected by a future step in the admission chain and the side effects therefore need to be undone. Requests with the dryRun attribute will be auto-rejected if they match a webhook with sideEffects == Unknown or Some. Defaults to Unknown.
    timeoutSeconds
    integer
    TimeoutSeconds specifies the timeout for this webhook. After the timeout passes, the webhook call will be ignored or the API call will fail based on the failure policy. The timeout value must be between 1 and 30 seconds. Default to 30 seconds.
    +

    MutatingWebhookConfiguration v1beta1 admissionregistration.k8s.io

    + + + + + +
    GroupVersionKind
    admissionregistration.k8s.iov1beta1MutatingWebhookConfiguration
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
    webhooks
    MutatingWebhook array
    patch strategy: merge
    patch merge key: name
    Webhooks is a list of webhooks and the affected resources and operations.
    +

    MutatingWebhookConfigurationList v1beta1 admissionregistration

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    MutatingWebhookConfiguration array
    List of MutatingWebhookConfiguration.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    +

    Write Operations

    +

    Create

    +

    create a MutatingWebhookConfiguration

    +

    HTTP Request

    +POST /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    MutatingWebhookConfiguration
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    MutatingWebhookConfiguration
    OK
    201
    MutatingWebhookConfiguration
    Created
    202
    MutatingWebhookConfiguration
    Accepted
    +

    Patch

    +

    partially update the specified MutatingWebhookConfiguration

    +

    HTTP Request

    +PATCH /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the MutatingWebhookConfiguration
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    MutatingWebhookConfiguration
    OK
    +

    Replace

    +

    replace the specified MutatingWebhookConfiguration

    +

    HTTP Request

    +PUT /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the MutatingWebhookConfiguration
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    MutatingWebhookConfiguration
    +

    Response

    + + + + + + +
    CodeDescription
    200
    MutatingWebhookConfiguration
    OK
    201
    MutatingWebhookConfiguration
    Created
    +

    Delete

    +

    delete a MutatingWebhookConfiguration

    +

    HTTP Request

    +DELETE /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the MutatingWebhookConfiguration
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of MutatingWebhookConfiguration

    +

    HTTP Request

    +DELETE /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified MutatingWebhookConfiguration

    +

    HTTP Request

    +GET /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the MutatingWebhookConfiguration
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    MutatingWebhookConfiguration
    OK
    +

    List

    +

    list or watch objects of kind MutatingWebhookConfiguration

    +

    HTTP Request

    +GET /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    MutatingWebhookConfigurationList
    OK
    +

    Watch

    +

    watch changes to an object of kind MutatingWebhookConfiguration. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/admissionregistration.k8s.io/v1beta1/watch/mutatingwebhookconfigurations/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the MutatingWebhookConfiguration
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of MutatingWebhookConfiguration. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/admissionregistration.k8s.io/v1beta1/watch/mutatingwebhookconfigurations +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    NonResourceAttributes v1beta1 authorization.k8s.io

    + + + + + +
    GroupVersionKind
    authorization.k8s.iov1beta1NonResourceAttributes
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + +
    FieldDescription
    path
    string
    Path is the URL path of the request
    verb
    string
    Verb is the standard HTTP verb
    +

    NonResourceRule v1beta1 authorization.k8s.io

    + + + + + +
    GroupVersionKind
    authorization.k8s.iov1beta1NonResourceRule
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + +
    FieldDescription
    nonResourceURLs
    string array
    NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path. "*" means all.
    verbs
    string array
    Verb is a list of kubernetes non-resource API verbs, like: get, post, put, delete, patch, head, options. "*" means all.
    +

    ObjectMetricSource v2beta1 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta1ObjectMetricSource
    +
    Other API versions of this object exist: +v2beta2 +
    + + + + + + + + + + +
    FieldDescription
    averageValue
    Quantity
    averageValue is the target value of the average of the metric across all relevant pods (as a quantity)
    metricName
    string
    metricName is the name of the metric in question.
    selector
    LabelSelector
    selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping When unset, just the metricName will be used to gather metrics.
    target
    CrossVersionObjectReference
    target is the described Kubernetes object.
    targetValue
    Quantity
    targetValue is the target value of the metric (as a quantity).
    +

    ObjectMetricStatus v2beta1 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta1ObjectMetricStatus
    +
    Other API versions of this object exist: +v2beta2 +
    + + + + + + + + + + +
    FieldDescription
    averageValue
    Quantity
    averageValue is the current value of the average of the metric across all relevant pods (as a quantity)
    currentValue
    Quantity
    currentValue is the current value of the metric (as a quantity).
    metricName
    string
    metricName is the name of the metric in question.
    selector
    LabelSelector
    selector is the string-encoded form of a standard kubernetes label selector for the given metric When set in the ObjectMetricSource, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.
    target
    CrossVersionObjectReference
    target is the described Kubernetes object.
    +

    Overhead v1beta1 node.k8s.io

    + + + + + +
    GroupVersionKind
    node.k8s.iov1beta1Overhead
    +
    Other API versions of this object exist: +v1 +v1alpha1 +
    +
    Appears In: + +
    + + + + + +
    FieldDescription
    podFixed
    object
    PodFixed represents the fixed resource overhead associated with running a pod.
    +

    Overhead v1alpha1 node.k8s.io

    + + + + + +
    GroupVersionKind
    node.k8s.iov1alpha1Overhead
    +
    Other API versions of this object exist: +v1 +v1beta1 +
    + + + + + + +
    FieldDescription
    podFixed
    object
    PodFixed represents the fixed resource overhead associated with running a pod.
    +

    PodDisruptionBudget v1beta1 policy

    + + + + + +
    GroupVersionKind
    policyv1beta1PodDisruptionBudget
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    spec
    PodDisruptionBudgetSpec
    Specification of the desired behavior of the PodDisruptionBudget.
    status
    PodDisruptionBudgetStatus
    Most recently observed status of the PodDisruptionBudget.
    +

    PodDisruptionBudgetSpec v1beta1 policy

    + + + + + + + + +
    FieldDescription
    maxUnavailableAn eviction is allowed if at most "maxUnavailable" pods selected by "selector" are unavailable after the eviction, i.e. even in absence of the evicted pod. For example, one can prevent all voluntary evictions by specifying 0. This is a mutually exclusive setting with "minAvailable".
    minAvailableAn eviction is allowed if at least "minAvailable" pods selected by "selector" will still be available after the eviction, i.e. even in the absence of the evicted pod. So for example you can prevent all voluntary evictions by specifying "100%".
    selector
    LabelSelector
    patch strategy: replace
    Label query over pods whose evictions are managed by the disruption budget. A null selector selects no pods. An empty selector ({}) also selects no pods, which differs from standard behavior of selecting all pods. In policy/v1, an empty selector will select all pods in the namespace.
    +

    PodDisruptionBudgetStatus v1beta1 policy

    + + + + + + + + + + + + +
    FieldDescription
    conditions
    Condition array
    patch strategy: merge
    patch merge key: type
    Conditions contain conditions for PDB. The disruption controller sets the DisruptionAllowed condition. The following are known values for the reason field (additional reasons could be added in the future): - SyncFailed: The controller encountered an error and wasn't able to compute the number of allowed disruptions. Therefore no disruptions are allowed and the status of the condition will be False. - InsufficientPods: The number of pods are either at or below the number required by the PodDisruptionBudget. No disruptions are allowed and the status of the condition will be False. - SufficientPods: There are more pods than required by the PodDisruptionBudget. The condition will be True, and the number of allowed disruptions are provided by the disruptionsAllowed property.
    currentHealthy
    integer
    current number of healthy pods
    desiredHealthy
    integer
    minimum desired number of healthy pods
    disruptedPods
    object
    DisruptedPods contains information about pods whose eviction was processed by the API server eviction subresource handler but has not yet been observed by the PodDisruptionBudget controller. A pod will be in this map from the time when the API server processed the eviction request to the time when the pod is seen by PDB controller as having been marked for deletion (or after a timeout). The key in the map is the name of the pod and the value is the time when the API server processed the eviction request. If the deletion didn't occur and a pod is still there it will be removed from the list automatically by PodDisruptionBudget controller after some time. If everything goes smooth this map should be empty for the most of the time. Large number of entries in the map may indicate problems with pod deletions.
    disruptionsAllowed
    integer
    Number of pod disruptions that are currently allowed.
    expectedPods
    integer
    total number of pods counted by this disruption budget
    observedGeneration
    integer
    Most recent generation observed when updating this PDB status. DisruptionsAllowed and other status information is valid only if observedGeneration equals to PDB's object generation.
    +

    PodDisruptionBudgetList v1beta1 policy

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    PodDisruptionBudget array
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    +

    Write Operations

    +

    Create

    +

    create a PodDisruptionBudget

    +

    HTTP Request

    +POST /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    PodDisruptionBudget
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    PodDisruptionBudget
    OK
    201
    PodDisruptionBudget
    Created
    202
    PodDisruptionBudget
    Accepted
    +

    Patch

    +

    partially update the specified PodDisruptionBudget

    +

    HTTP Request

    +PATCH /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the PodDisruptionBudget
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    PodDisruptionBudget
    OK
    +

    Replace

    +

    replace the specified PodDisruptionBudget

    +

    HTTP Request

    +PUT /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the PodDisruptionBudget
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    PodDisruptionBudget
    +

    Response

    + + + + + + +
    CodeDescription
    200
    PodDisruptionBudget
    OK
    201
    PodDisruptionBudget
    Created
    +

    Delete

    +

    delete a PodDisruptionBudget

    +

    HTTP Request

    +DELETE /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the PodDisruptionBudget
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of PodDisruptionBudget

    +

    HTTP Request

    +DELETE /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified PodDisruptionBudget

    +

    HTTP Request

    +GET /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the PodDisruptionBudget
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    PodDisruptionBudget
    OK
    +

    List

    +

    list or watch objects of kind PodDisruptionBudget

    +

    HTTP Request

    +GET /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    PodDisruptionBudgetList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind PodDisruptionBudget

    +

    HTTP Request

    +GET /apis/policy/v1beta1/poddisruptionbudgets +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    PodDisruptionBudgetList
    OK
    +

    Watch

    +

    watch changes to an object of kind PodDisruptionBudget. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/policy/v1beta1/watch/namespaces/{namespace}/poddisruptionbudgets/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the PodDisruptionBudget
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of PodDisruptionBudget. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/policy/v1beta1/watch/namespaces/{namespace}/poddisruptionbudgets +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of PodDisruptionBudget. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/policy/v1beta1/watch/poddisruptionbudgets +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Status Operations

    +

    Patch Status

    +

    partially update status of the specified PodDisruptionBudget

    +

    HTTP Request

    +PATCH /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the PodDisruptionBudget
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    PodDisruptionBudget
    OK
    +

    Read Status

    +

    read status of the specified PodDisruptionBudget

    +

    HTTP Request

    +GET /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the PodDisruptionBudget
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    PodDisruptionBudget
    OK
    +

    Replace Status

    +

    replace status of the specified PodDisruptionBudget

    +

    HTTP Request

    +PUT /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}/status +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the PodDisruptionBudget
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    PodDisruptionBudget
    +

    Response

    + + + + + + +
    CodeDescription
    200
    PodDisruptionBudget
    OK
    201
    PodDisruptionBudget
    Created
    +

    PodsMetricSource v2beta1 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta1PodsMetricSource
    +
    Other API versions of this object exist: +v2beta2 +
    + + + + + + + + +
    FieldDescription
    metricName
    string
    metricName is the name of the metric in question
    selector
    LabelSelector
    selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping When unset, just the metricName will be used to gather metrics.
    targetAverageValue
    Quantity
    targetAverageValue is the target value of the average of the metric across all relevant pods (as a quantity)
    +

    PodsMetricStatus v2beta1 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta1PodsMetricStatus
    +
    Other API versions of this object exist: +v2beta2 +
    + + + + + + + + +
    FieldDescription
    currentAverageValue
    Quantity
    currentAverageValue is the current value of the average of the metric across all relevant pods (as a quantity)
    metricName
    string
    metricName is the name of the metric in question
    selector
    LabelSelector
    selector is the string-encoded form of a standard kubernetes label selector for the given metric When set in the PodsMetricSource, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.
    +

    PolicyRule v1beta1 rbac.authorization.k8s.io

    + + + + + +
    GroupVersionKind
    rbac.authorization.k8s.iov1beta1PolicyRule
    +
    Other API versions of this object exist: +v1 +v1alpha1 +
    + + + + + + + + + + +
    FieldDescription
    apiGroups
    string array
    APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed.
    nonResourceURLs
    string array
    NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.
    resourceNames
    string array
    ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
    resources
    string array
    Resources is a list of resources this rule applies to. '\*' represents all resources in the specified apiGroups. '\*/foo' represents the subresource 'foo' for all resources in the specified apiGroups.
    verbs
    string array
    Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.
    +

    PolicyRule v1alpha1 rbac.authorization.k8s.io

    + + + + + +
    GroupVersionKind
    rbac.authorization.k8s.iov1alpha1PolicyRule
    +
    Other API versions of this object exist: +v1 +v1beta1 +
    + + + + + + + + + + +
    FieldDescription
    apiGroups
    string array
    APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed.
    nonResourceURLs
    string array
    NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.
    resourceNames
    string array
    ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
    resources
    string array
    Resources is a list of resources this rule applies to. ResourceAll represents all resources.
    verbs
    string array
    Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.
    +

    PriorityClass v1beta1 scheduling.k8s.io

    + + + + + +
    GroupVersionKind
    scheduling.k8s.iov1beta1PriorityClass
    +
    Other API versions of this object exist: +v1 +v1alpha1 +
    + + + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    description
    string
    description is an arbitrary string that usually provides guidelines on when this priority class should be used.
    globalDefault
    boolean
    globalDefault specifies whether this PriorityClass should be considered as the default priority for pods that do not have any priority class. Only one PriorityClass can be marked as `globalDefault`. However, if more than one PriorityClasses exists with their `globalDefault` field set to true, the smallest value of such global default PriorityClasses will be used as the default priority.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    preemptionPolicy
    string
    PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate.
    value
    integer
    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.
    +

    PriorityClassList v1beta1 scheduling

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    PriorityClass array
    items is the list of PriorityClasses
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    +

    Write Operations

    +

    Create

    +

    create a PriorityClass

    +

    HTTP Request

    +POST /apis/scheduling.k8s.io/v1beta1/priorityclasses +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    PriorityClass
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    PriorityClass
    OK
    201
    PriorityClass
    Created
    202
    PriorityClass
    Accepted
    +

    Patch

    +

    partially update the specified PriorityClass

    +

    HTTP Request

    +PATCH /apis/scheduling.k8s.io/v1beta1/priorityclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the PriorityClass
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    PriorityClass
    OK
    +

    Replace

    +

    replace the specified PriorityClass

    +

    HTTP Request

    +PUT /apis/scheduling.k8s.io/v1beta1/priorityclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the PriorityClass
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    PriorityClass
    +

    Response

    + + + + + + +
    CodeDescription
    200
    PriorityClass
    OK
    201
    PriorityClass
    Created
    +

    Delete

    +

    delete a PriorityClass

    +

    HTTP Request

    +DELETE /apis/scheduling.k8s.io/v1beta1/priorityclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the PriorityClass
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of PriorityClass

    +

    HTTP Request

    +DELETE /apis/scheduling.k8s.io/v1beta1/priorityclasses +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified PriorityClass

    +

    HTTP Request

    +GET /apis/scheduling.k8s.io/v1beta1/priorityclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the PriorityClass
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    PriorityClass
    OK
    +

    List

    +

    list or watch objects of kind PriorityClass

    +

    HTTP Request

    +GET /apis/scheduling.k8s.io/v1beta1/priorityclasses +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    PriorityClassList
    OK
    +

    Watch

    +

    watch changes to an object of kind PriorityClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/scheduling.k8s.io/v1beta1/watch/priorityclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the PriorityClass
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of PriorityClass. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/scheduling.k8s.io/v1beta1/watch/priorityclasses +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    PriorityClass v1alpha1 scheduling.k8s.io

    + + + + + +
    GroupVersionKind
    scheduling.k8s.iov1alpha1PriorityClass
    +
    Other API versions of this object exist: +v1 +v1beta1 +
    + + + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    description
    string
    description is an arbitrary string that usually provides guidelines on when this priority class should be used.
    globalDefault
    boolean
    globalDefault specifies whether this PriorityClass should be considered as the default priority for pods that do not have any priority class. Only one PriorityClass can be marked as `globalDefault`. However, if more than one PriorityClasses exists with their `globalDefault` field set to true, the smallest value of such global default PriorityClasses will be used as the default priority.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    preemptionPolicy
    string
    PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate.
    value
    integer
    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.
    +

    PriorityClassList v1alpha1 scheduling

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    PriorityClass array
    items is the list of PriorityClasses
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    +

    Write Operations

    +

    Create

    +

    create a PriorityClass

    +

    HTTP Request

    +POST /apis/scheduling.k8s.io/v1alpha1/priorityclasses +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    PriorityClass
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    PriorityClass
    OK
    201
    PriorityClass
    Created
    202
    PriorityClass
    Accepted
    +

    Patch

    +

    partially update the specified PriorityClass

    +

    HTTP Request

    +PATCH /apis/scheduling.k8s.io/v1alpha1/priorityclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the PriorityClass
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    PriorityClass
    OK
    +

    Replace

    +

    replace the specified PriorityClass

    +

    HTTP Request

    +PUT /apis/scheduling.k8s.io/v1alpha1/priorityclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the PriorityClass
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    PriorityClass
    +

    Response

    + + + + + + +
    CodeDescription
    200
    PriorityClass
    OK
    201
    PriorityClass
    Created
    +

    Delete

    +

    delete a PriorityClass

    +

    HTTP Request

    +DELETE /apis/scheduling.k8s.io/v1alpha1/priorityclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the PriorityClass
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of PriorityClass

    +

    HTTP Request

    +DELETE /apis/scheduling.k8s.io/v1alpha1/priorityclasses +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified PriorityClass

    +

    HTTP Request

    +GET /apis/scheduling.k8s.io/v1alpha1/priorityclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the PriorityClass
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    PriorityClass
    OK
    +

    List

    +

    list or watch objects of kind PriorityClass

    +

    HTTP Request

    +GET /apis/scheduling.k8s.io/v1alpha1/priorityclasses +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    PriorityClassList
    OK
    +

    Watch

    +

    watch changes to an object of kind PriorityClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/scheduling.k8s.io/v1alpha1/watch/priorityclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the PriorityClass
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of PriorityClass. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/scheduling.k8s.io/v1alpha1/watch/priorityclasses +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    ResourceAttributes v1beta1 authorization.k8s.io

    + + + + + +
    GroupVersionKind
    authorization.k8s.iov1beta1ResourceAttributes
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + + + + + + +
    FieldDescription
    group
    string
    Group is the API Group of the Resource. "*" means all.
    name
    string
    Name is the name of the resource being requested for a "get" or deleted for a "delete". "" (empty) means all.
    namespace
    string
    Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces "" (empty) is defaulted for LocalSubjectAccessReviews "" (empty) is empty for cluster-scoped resources "" (empty) means "all" for namespace scoped resources from a SubjectAccessReview or SelfSubjectAccessReview
    resource
    string
    Resource is one of the existing resource types. "*" means all.
    subresource
    string
    Subresource is one of the existing resource types. "" means none.
    verb
    string
    Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all.
    version
    string
    Version is the API Version of the Resource. "*" means all.
    +

    ResourceMetricSource v2beta1 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta1ResourceMetricSource
    +
    Other API versions of this object exist: +v2beta2 +
    + + + + + + + + +
    FieldDescription
    name
    string
    name is the name of the resource in question.
    targetAverageUtilization
    integer
    targetAverageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.
    targetAverageValue
    Quantity
    targetAverageValue is the target value of the average of the resource metric across all relevant pods, as a raw value (instead of as a percentage of the request), similar to the "pods" metric source type.
    +

    ResourceMetricStatus v2beta1 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta1ResourceMetricStatus
    +
    Other API versions of this object exist: +v2beta2 +
    + + + + + + + + +
    FieldDescription
    currentAverageUtilization
    integer
    currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. It will only be present if `targetAverageValue` was set in the corresponding metric specification.
    currentAverageValue
    Quantity
    currentAverageValue is the current value of the average of the resource metric across all relevant pods, as a raw value (instead of as a percentage of the request), similar to the "pods" metric source type. It will always be set, regardless of the corresponding metric specification.
    name
    string
    name is the name of the resource in question.
    +

    ResourceRule v1beta1 authorization.k8s.io

    + + + + + +
    GroupVersionKind
    authorization.k8s.iov1beta1ResourceRule
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + + + +
    FieldDescription
    apiGroups
    string array
    APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. "*" means all.
    resourceNames
    string array
    ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. "*" means all.
    resources
    string array
    Resources is a list of resources this rule applies to. "*" means all in the specified apiGroups. "*/foo" represents the subresource 'foo' for all resources in the specified apiGroups.
    verbs
    string array
    Verb is a list of kubernetes resource API verbs, like: get, list, watch, create, update, delete, proxy. "*" means all.
    +

    Role v1beta1 rbac.authorization.k8s.io

    + + + + + +
    GroupVersionKind
    rbac.authorization.k8s.iov1beta1Role
    +
    Other API versions of this object exist: +v1 +v1alpha1 +
    +
    Appears In: + +
    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata.
    rules
    PolicyRule array
    Rules holds all the PolicyRules for this Role
    +

    RoleList v1beta1 rbac

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    Role array
    Items is a list of Roles
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard object's metadata.
    +

    Write Operations

    +

    Create

    +

    create a Role

    +

    HTTP Request

    +POST /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Role
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    Role
    OK
    201
    Role
    Created
    202
    Role
    Accepted
    +

    Patch

    +

    partially update the specified Role

    +

    HTTP Request

    +PATCH /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Role
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    Role
    OK
    +

    Replace

    +

    replace the specified Role

    +

    HTTP Request

    +PUT /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Role
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Role
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Role
    OK
    201
    Role
    Created
    +

    Delete

    +

    delete a Role

    +

    HTTP Request

    +DELETE /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Role
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of Role

    +

    HTTP Request

    +DELETE /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified Role

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Role
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    Role
    OK
    +

    List

    +

    list or watch objects of kind Role

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    RoleList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind Role

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1beta1/roles +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    RoleList
    OK
    +

    Watch

    +

    watch changes to an object of kind Role. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/roles/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Role
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of Role. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/roles +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of Role. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1beta1/watch/roles +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Role v1alpha1 rbac.authorization.k8s.io

    + + + + + +
    GroupVersionKind
    rbac.authorization.k8s.iov1alpha1Role
    +
    Other API versions of this object exist: +v1 +v1beta1 +
    +
    Appears In: + +
    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata.
    rules
    PolicyRule array
    Rules holds all the PolicyRules for this Role
    +

    RoleList v1alpha1 rbac

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    Role array
    Items is a list of Roles
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard object's metadata.
    +

    Write Operations

    +

    Create

    +

    create a Role

    +

    HTTP Request

    +POST /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Role
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    Role
    OK
    201
    Role
    Created
    202
    Role
    Accepted
    +

    Patch

    +

    partially update the specified Role

    +

    HTTP Request

    +PATCH /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Role
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    Role
    OK
    +

    Replace

    +

    replace the specified Role

    +

    HTTP Request

    +PUT /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Role
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Role
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Role
    OK
    201
    Role
    Created
    +

    Delete

    +

    delete a Role

    +

    HTTP Request

    +DELETE /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Role
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of Role

    +

    HTTP Request

    +DELETE /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified Role

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Role
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    Role
    OK
    +

    List

    +

    list or watch objects of kind Role

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    RoleList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind Role

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1alpha1/roles +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    RoleList
    OK
    +

    Watch

    +

    watch changes to an object of kind Role. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/roles/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the Role
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of Role. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/roles +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of Role. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/roles +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    RoleBinding v1beta1 rbac.authorization.k8s.io

    + + + + + +
    GroupVersionKind
    rbac.authorization.k8s.iov1beta1RoleBinding
    +
    Other API versions of this object exist: +v1 +v1alpha1 +
    +
    Appears In: + +
    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata.
    roleRef
    RoleRef
    RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.
    subjects
    Subject array
    Subjects holds references to the objects the role applies to.
    +

    RoleBindingList v1beta1 rbac

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    RoleBinding array
    Items is a list of RoleBindings
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard object's metadata.
    +

    Write Operations

    +

    Create

    +

    create a RoleBinding

    +

    HTTP Request

    +POST /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    RoleBinding
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    RoleBinding
    OK
    201
    RoleBinding
    Created
    202
    RoleBinding
    Accepted
    +

    Patch

    +

    partially update the specified RoleBinding

    +

    HTTP Request

    +PATCH /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the RoleBinding
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    RoleBinding
    OK
    +

    Replace

    +

    replace the specified RoleBinding

    +

    HTTP Request

    +PUT /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the RoleBinding
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    RoleBinding
    +

    Response

    + + + + + + +
    CodeDescription
    200
    RoleBinding
    OK
    201
    RoleBinding
    Created
    +

    Delete

    +

    delete a RoleBinding

    +

    HTTP Request

    +DELETE /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the RoleBinding
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of RoleBinding

    +

    HTTP Request

    +DELETE /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified RoleBinding

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the RoleBinding
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    RoleBinding
    OK
    +

    List

    +

    list or watch objects of kind RoleBinding

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    RoleBindingList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind RoleBinding

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1beta1/rolebindings +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    RoleBindingList
    OK
    +

    Watch

    +

    watch changes to an object of kind RoleBinding. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/rolebindings/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the RoleBinding
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of RoleBinding. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/rolebindings +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of RoleBinding. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1beta1/watch/rolebindings +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    RoleBinding v1alpha1 rbac.authorization.k8s.io

    + + + + + +
    GroupVersionKind
    rbac.authorization.k8s.iov1alpha1RoleBinding
    +
    Other API versions of this object exist: +v1 +v1beta1 +
    +
    Appears In: + +
    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata.
    roleRef
    RoleRef
    RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.
    subjects
    Subject array
    Subjects holds references to the objects the role applies to.
    +

    RoleBindingList v1alpha1 rbac

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    RoleBinding array
    Items is a list of RoleBindings
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard object's metadata.
    +

    Write Operations

    +

    Create

    +

    create a RoleBinding

    +

    HTTP Request

    +POST /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    RoleBinding
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    RoleBinding
    OK
    201
    RoleBinding
    Created
    202
    RoleBinding
    Accepted
    +

    Patch

    +

    partially update the specified RoleBinding

    +

    HTTP Request

    +PATCH /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the RoleBinding
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    RoleBinding
    OK
    +

    Replace

    +

    replace the specified RoleBinding

    +

    HTTP Request

    +PUT /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the RoleBinding
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    RoleBinding
    +

    Response

    + + + + + + +
    CodeDescription
    200
    RoleBinding
    OK
    201
    RoleBinding
    Created
    +

    Delete

    +

    delete a RoleBinding

    +

    HTTP Request

    +DELETE /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the RoleBinding
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of RoleBinding

    +

    HTTP Request

    +DELETE /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified RoleBinding

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the RoleBinding
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    RoleBinding
    OK
    +

    List

    +

    list or watch objects of kind RoleBinding

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    RoleBindingList
    OK
    +

    List All Namespaces

    +

    list or watch objects of kind RoleBinding

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1alpha1/rolebindings +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    RoleBindingList
    OK
    +

    Watch

    +

    watch changes to an object of kind RoleBinding. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/rolebindings/{name} +

    Path Parameters

    + + + + + + +
    ParameterDescription
    namename of the RoleBinding
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of RoleBinding. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/rolebindings +

    Path Parameters

    + + + + + +
    ParameterDescription
    namespaceobject name and auth scope, such as for teams and projects
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List All Namespaces

    +

    watch individual changes to a list of RoleBinding. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/rolebindings +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    RoleRef v1beta1 rbac.authorization.k8s.io

    + + + + + +
    GroupVersionKind
    rbac.authorization.k8s.iov1beta1RoleRef
    +
    Other API versions of this object exist: +v1 +v1alpha1 +
    + + + + + + + + +
    FieldDescription
    apiGroup
    string
    APIGroup is the group for the resource being referenced
    kind
    string
    Kind is the type of resource being referenced
    name
    string
    Name is the name of resource being referenced
    +

    RoleRef v1alpha1 rbac.authorization.k8s.io

    + + + + + +
    GroupVersionKind
    rbac.authorization.k8s.iov1alpha1RoleRef
    +
    Other API versions of this object exist: +v1 +v1beta1 +
    + + + + + + + + +
    FieldDescription
    apiGroup
    string
    APIGroup is the group for the resource being referenced
    kind
    string
    Kind is the type of resource being referenced
    name
    string
    Name is the name of resource being referenced
    +

    RuleWithOperations v1beta1 admissionregistration.k8s.io

    + + + + + +
    GroupVersionKind
    admissionregistration.k8s.iov1beta1RuleWithOperations
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + + + + +
    FieldDescription
    apiGroups
    string array
    APIGroups is the API groups the resources belong to. '\*' is all groups. If '\*' is present, the length of the slice must be one. Required.
    apiVersions
    string array
    APIVersions is the API versions the resources belong to. '\*' is all versions. If '\*' is present, the length of the slice must be one. Required.
    operations
    string array
    Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. If '\*' is present, the length of the slice must be one. Required.
    resources
    string array
    Resources is a list of resources this rule applies to. For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '\*' means all resources, but not subresources. 'pods/\*' means all subresources of pods. '\*/scale' means all scale subresources. '\*/\*' means all resources and their subresources. If wildcard is present, the validation rule will ensure resources do not overlap with each other. Depending on the enclosing object, subresources might not be allowed. Required.
    scope
    string
    scope specifies the scope of this rule. Valid values are "Cluster", "Namespaced", and "*" "Cluster" means that only cluster-scoped resources will match this rule. Namespace API objects are cluster-scoped. "Namespaced" means that only namespaced resources will match this rule. "*" means that there are no scope restrictions. Subresources match the scope of their parent resource. Default is "*".
    +

    RuntimeClass v1beta1 node.k8s.io

    + + + + + +
    GroupVersionKind
    node.k8s.iov1beta1RuntimeClass
    +
    Other API versions of this object exist: +v1 +v1alpha1 +
    +
    Appears In: + +
    + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    handler
    string
    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.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    overhead
    Overhead
    Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. For more details, see https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md This field is alpha-level as of Kubernetes v1.15, and is only honored by servers that enable the PodOverhead feature.
    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.
    +

    RuntimeClassList v1beta1 node

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    RuntimeClass array
    Items is a list of schema objects.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    +

    Write Operations

    +

    Create

    +

    create a RuntimeClass

    +

    HTTP Request

    +POST /apis/node.k8s.io/v1beta1/runtimeclasses +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    RuntimeClass
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    RuntimeClass
    OK
    201
    RuntimeClass
    Created
    202
    RuntimeClass
    Accepted
    +

    Patch

    +

    partially update the specified RuntimeClass

    +

    HTTP Request

    +PATCH /apis/node.k8s.io/v1beta1/runtimeclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the RuntimeClass
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    RuntimeClass
    OK
    +

    Replace

    +

    replace the specified RuntimeClass

    +

    HTTP Request

    +PUT /apis/node.k8s.io/v1beta1/runtimeclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the RuntimeClass
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    RuntimeClass
    +

    Response

    + + + + + + +
    CodeDescription
    200
    RuntimeClass
    OK
    201
    RuntimeClass
    Created
    +

    Delete

    +

    delete a RuntimeClass

    +

    HTTP Request

    +DELETE /apis/node.k8s.io/v1beta1/runtimeclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the RuntimeClass
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of RuntimeClass

    +

    HTTP Request

    +DELETE /apis/node.k8s.io/v1beta1/runtimeclasses +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified RuntimeClass

    +

    HTTP Request

    +GET /apis/node.k8s.io/v1beta1/runtimeclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the RuntimeClass
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    RuntimeClass
    OK
    +

    List

    +

    list or watch objects of kind RuntimeClass

    +

    HTTP Request

    +GET /apis/node.k8s.io/v1beta1/runtimeclasses +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    RuntimeClassList
    OK
    +

    Watch

    +

    watch changes to an object of kind RuntimeClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/node.k8s.io/v1beta1/watch/runtimeclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the RuntimeClass
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of RuntimeClass. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/node.k8s.io/v1beta1/watch/runtimeclasses +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    RuntimeClass v1alpha1 node.k8s.io

    + + + + + +
    GroupVersionKind
    node.k8s.iov1alpha1RuntimeClass
    +
    Other API versions of this object exist: +v1 +v1beta1 +
    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    spec
    RuntimeClassSpec
    Specification of the RuntimeClass More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    +

    RuntimeClassSpec v1alpha1 node

    +
    Appears In: + +
    + + + + + + + +
    FieldDescription
    overhead
    Overhead
    Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. For more details, see https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md This field is alpha-level as of Kubernetes v1.15, and is only honored by servers that enable the PodOverhead feature.
    runtimeHandler
    string
    RuntimeHandler 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 RuntimeHandler must be lowercase, conform to the DNS Label (RFC 1123) requirements, and is immutable.
    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.
    +

    RuntimeClassList v1alpha1 node

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    RuntimeClass array
    Items is a list of schema objects.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    +

    Write Operations

    +

    Create

    +

    create a RuntimeClass

    +

    HTTP Request

    +POST /apis/node.k8s.io/v1alpha1/runtimeclasses +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    RuntimeClass
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    RuntimeClass
    OK
    201
    RuntimeClass
    Created
    202
    RuntimeClass
    Accepted
    +

    Patch

    +

    partially update the specified RuntimeClass

    +

    HTTP Request

    +PATCH /apis/node.k8s.io/v1alpha1/runtimeclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the RuntimeClass
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    RuntimeClass
    OK
    +

    Replace

    +

    replace the specified RuntimeClass

    +

    HTTP Request

    +PUT /apis/node.k8s.io/v1alpha1/runtimeclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the RuntimeClass
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    RuntimeClass
    +

    Response

    + + + + + + +
    CodeDescription
    200
    RuntimeClass
    OK
    201
    RuntimeClass
    Created
    +

    Delete

    +

    delete a RuntimeClass

    +

    HTTP Request

    +DELETE /apis/node.k8s.io/v1alpha1/runtimeclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the RuntimeClass
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of RuntimeClass

    +

    HTTP Request

    +DELETE /apis/node.k8s.io/v1alpha1/runtimeclasses +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified RuntimeClass

    +

    HTTP Request

    +GET /apis/node.k8s.io/v1alpha1/runtimeclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the RuntimeClass
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    RuntimeClass
    OK
    +

    List

    +

    list or watch objects of kind RuntimeClass

    +

    HTTP Request

    +GET /apis/node.k8s.io/v1alpha1/runtimeclasses +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    RuntimeClassList
    OK
    +

    Watch

    +

    watch changes to an object of kind RuntimeClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/node.k8s.io/v1alpha1/watch/runtimeclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the RuntimeClass
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of RuntimeClass. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/node.k8s.io/v1alpha1/watch/runtimeclasses +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Scheduling v1beta1 node.k8s.io

    + + + + + +
    GroupVersionKind
    node.k8s.iov1beta1Scheduling
    +
    Other API versions of this object exist: +v1 +v1alpha1 +
    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    nodeSelector
    object
    nodeSelector lists labels that must be present on nodes that support this RuntimeClass. Pods using this RuntimeClass can only be scheduled to a node matched by this selector. The RuntimeClass nodeSelector is merged with a pod's existing nodeSelector. Any conflicts will cause the pod to be rejected in admission.
    tolerations
    Toleration array
    tolerations are appended (excluding duplicates) to pods running with this RuntimeClass during admission, effectively unioning the set of nodes tolerated by the pod and the RuntimeClass.
    +

    Scheduling v1alpha1 node.k8s.io

    + + + + + +
    GroupVersionKind
    node.k8s.iov1alpha1Scheduling
    +
    Other API versions of this object exist: +v1 +v1beta1 +
    + + + + + + + +
    FieldDescription
    nodeSelector
    object
    nodeSelector lists labels that must be present on nodes that support this RuntimeClass. Pods using this RuntimeClass can only be scheduled to a node matched by this selector. The RuntimeClass nodeSelector is merged with a pod's existing nodeSelector. Any conflicts will cause the pod to be rejected in admission.
    tolerations
    Toleration array
    tolerations are appended (excluding duplicates) to pods running with this RuntimeClass during admission, effectively unioning the set of nodes tolerated by the pod and the RuntimeClass.
    +

    SelfSubjectAccessReview v1beta1 authorization.k8s.io

    + + + + + +
    GroupVersionKind
    authorization.k8s.iov1beta1SelfSubjectAccessReview
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    spec
    SelfSubjectAccessReviewSpec
    Spec holds information about the request being evaluated. user and groups must be empty
    status
    SubjectAccessReviewStatus
    Status is filled in by the server and indicates whether the request is allowed or not
    +

    SelfSubjectAccessReviewSpec v1beta1 authorization

    + + + + + + + +
    FieldDescription
    nonResourceAttributes
    NonResourceAttributes
    NonResourceAttributes describes information for a non-resource access request
    resourceAttributes
    ResourceAttributes
    ResourceAuthorizationAttributes describes information for a resource access request
    +

    Write Operations

    +

    Create

    +

    create a SelfSubjectAccessReview

    +

    HTTP Request

    +POST /apis/authorization.k8s.io/v1beta1/selfsubjectaccessreviews +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    dryRunWhen 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
    fieldManagerfieldManager 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.
    prettyIf 'true', then the output is pretty printed.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    SelfSubjectAccessReview
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    SelfSubjectAccessReview
    OK
    201
    SelfSubjectAccessReview
    Created
    202
    SelfSubjectAccessReview
    Accepted
    +

    SelfSubjectRulesReview v1beta1 authorization.k8s.io

    + + + + + +
    GroupVersionKind
    authorization.k8s.iov1beta1SelfSubjectRulesReview
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    spec
    SelfSubjectRulesReviewSpec
    Spec holds information about the request being evaluated.
    status
    SubjectRulesReviewStatus
    Status is filled in by the server and indicates the set of actions a user can perform.
    +

    SelfSubjectRulesReviewSpec v1beta1 authorization

    + + + + + + +
    FieldDescription
    namespace
    string
    Namespace to evaluate rules for. Required.
    +

    Write Operations

    +

    Create

    +

    create a SelfSubjectRulesReview

    +

    HTTP Request

    +POST /apis/authorization.k8s.io/v1beta1/selfsubjectrulesreviews +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    dryRunWhen 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
    fieldManagerfieldManager 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.
    prettyIf 'true', then the output is pretty printed.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    SelfSubjectRulesReview
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    SelfSubjectRulesReview
    OK
    201
    SelfSubjectRulesReview
    Created
    202
    SelfSubjectRulesReview
    Accepted
    +

    ServiceReference v1 apiextensions.k8s.io

    + + + + + +
    GroupVersionKind
    apiextensions.k8s.iov1ServiceReference
    +
    Other API versions of this object exist: +v1beta1 +v1beta1 +v1beta1 +
    + + + + + + + + + +
    FieldDescription
    name
    string
    name is the name of the service. Required
    namespace
    string
    namespace is the namespace of the service. Required
    path
    string
    path is an optional URL path at which the webhook will be contacted.
    port
    integer
    port is an optional service port at which the webhook will be contacted. `port` should be a valid port number (1-65535, inclusive). Defaults to 443 for backward compatibility.
    +

    ServiceReference v1 apiregistration.k8s.io

    + + + + + +
    GroupVersionKind
    apiregistration.k8s.iov1ServiceReference
    +
    Other API versions of this object exist: +v1beta1 +v1beta1 +v1beta1 +
    + + + + + + + + +
    FieldDescription
    name
    string
    Name is the name of the service
    namespace
    string
    Namespace is the namespace of the service
    port
    integer
    If specified, the port on the service that hosting webhook. Default to 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive).
    +

    ServiceReference v1beta1 admissionregistration.k8s.io

    + + + + + +
    GroupVersionKind
    admissionregistration.k8s.iov1beta1ServiceReference
    +
    Other API versions of this object exist: +v1 +v1 +v1 +
    + + + + + + + + + +
    FieldDescription
    name
    string
    `name` is the name of the service. Required
    namespace
    string
    `namespace` is the namespace of the service. Required
    path
    string
    `path` is an optional URL path which will be sent in any request to this service.
    port
    integer
    If specified, the port on the service that hosting webhook. Default to 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive).
    +

    ServiceReference v1beta1 apiextensions.k8s.io

    + + + + + +
    GroupVersionKind
    apiextensions.k8s.iov1beta1ServiceReference
    +
    Other API versions of this object exist: +v1 +v1 +v1 +
    + + + + + + + + + +
    FieldDescription
    name
    string
    name is the name of the service. Required
    namespace
    string
    namespace is the namespace of the service. Required
    path
    string
    path is an optional URL path at which the webhook will be contacted.
    port
    integer
    port is an optional service port at which the webhook will be contacted. `port` should be a valid port number (1-65535, inclusive). Defaults to 443 for backward compatibility.
    +

    ServiceReference v1beta1 apiregistration.k8s.io

    + + + + + +
    GroupVersionKind
    apiregistration.k8s.iov1beta1ServiceReference
    +
    Other API versions of this object exist: +v1 +v1 +v1 +
    + + + + + + + + +
    FieldDescription
    name
    string
    Name is the name of the service
    namespace
    string
    Namespace is the namespace of the service
    port
    integer
    If specified, the port on the service that hosting webhook. Default to 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive).
    +

    StorageClass v1beta1 storage.k8s.io

    + + + + + +
    GroupVersionKind
    storage.k8s.iov1beta1StorageClass
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + + + + + + + + + +
    FieldDescription
    allowVolumeExpansion
    boolean
    AllowVolumeExpansion shows whether the storage class allow volume expand
    allowedTopologies
    TopologySelectorTerm array
    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.
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    mountOptions
    string array
    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.
    parameters
    object
    Parameters holds the parameters for the provisioner that should create volumes of this storage class.
    provisioner
    string
    Provisioner indicates the type of the provisioner.
    reclaimPolicy
    string
    Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. 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.
    +

    StorageClassList v1beta1 storage

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    StorageClass array
    Items is the list of StorageClasses
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    +

    Write Operations

    +

    Create

    +

    create a StorageClass

    +

    HTTP Request

    +POST /apis/storage.k8s.io/v1beta1/storageclasses +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    StorageClass
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    StorageClass
    OK
    201
    StorageClass
    Created
    202
    StorageClass
    Accepted
    +

    Patch

    +

    partially update the specified StorageClass

    +

    HTTP Request

    +PATCH /apis/storage.k8s.io/v1beta1/storageclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the StorageClass
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    StorageClass
    OK
    +

    Replace

    +

    replace the specified StorageClass

    +

    HTTP Request

    +PUT /apis/storage.k8s.io/v1beta1/storageclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the StorageClass
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    StorageClass
    +

    Response

    + + + + + + +
    CodeDescription
    200
    StorageClass
    OK
    201
    StorageClass
    Created
    +

    Delete

    +

    delete a StorageClass

    +

    HTTP Request

    +DELETE /apis/storage.k8s.io/v1beta1/storageclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the StorageClass
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    StorageClass
    OK
    202
    StorageClass
    Accepted
    +

    Delete Collection

    +

    delete collection of StorageClass

    +

    HTTP Request

    +DELETE /apis/storage.k8s.io/v1beta1/storageclasses +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified StorageClass

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1beta1/storageclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the StorageClass
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    StorageClass
    OK
    +

    List

    +

    list or watch objects of kind StorageClass

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1beta1/storageclasses +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    StorageClassList
    OK
    +

    Watch

    +

    watch changes to an object of kind StorageClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1beta1/watch/storageclasses/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the StorageClass
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of StorageClass. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1beta1/watch/storageclasses +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Subject v1 rbac.authorization.k8s.io

    + + + + + +
    GroupVersionKind
    rbac.authorization.k8s.iov1Subject
    +
    Other API versions of this object exist: +v1beta1 +v1beta1 +v1alpha1 +
    + + + + + + + + + +
    FieldDescription
    apiGroup
    string
    APIGroup holds the API group of the referenced subject. Defaults to "" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects.
    kind
    string
    Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error.
    name
    string
    Name of the object being referenced.
    namespace
    string
    Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error.
    +

    Subject v1beta1 rbac.authorization.k8s.io

    + + + + + +
    GroupVersionKind
    rbac.authorization.k8s.iov1beta1Subject
    +
    Other API versions of this object exist: +v1 +v1alpha1 +
    + + + + + + + + + +
    FieldDescription
    apiGroup
    string
    APIGroup holds the API group of the referenced subject. Defaults to "" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects.
    kind
    string
    Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error.
    name
    string
    Name of the object being referenced.
    namespace
    string
    Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error.
    +

    Subject v1alpha1 rbac.authorization.k8s.io

    + + + + + +
    GroupVersionKind
    rbac.authorization.k8s.iov1alpha1Subject
    +
    Other API versions of this object exist: +v1beta1 +v1 +v1beta1 +
    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion holds the API group and version of the referenced subject. Defaults to "v1" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io/v1alpha1" for User and Group subjects.
    kind
    string
    Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error.
    name
    string
    Name of the object being referenced.
    namespace
    string
    Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error.
    +

    SubjectAccessReview v1beta1 authorization.k8s.io

    + + + + + +
    GroupVersionKind
    authorization.k8s.iov1beta1SubjectAccessReview
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    spec
    SubjectAccessReviewSpec
    Spec holds information about the request being evaluated
    status
    SubjectAccessReviewStatus
    Status is filled in by the server and indicates whether the request is allowed or not
    +

    SubjectAccessReviewSpec v1beta1 authorization

    + + + + + + + + + + + +
    FieldDescription
    extra
    object
    Extra corresponds to the user.Info.GetExtra() method from the authenticator. Since that is input to the authorizer it needs a reflection here.
    group
    string array
    Groups is the groups you're testing for.
    nonResourceAttributes
    NonResourceAttributes
    NonResourceAttributes describes information for a non-resource access request
    resourceAttributes
    ResourceAttributes
    ResourceAuthorizationAttributes describes information for a resource access request
    uid
    string
    UID information about the requesting user.
    user
    string
    User is the user you're testing for. If you specify "User" but not "Group", then is it interpreted as "What if User were not a member of any groups
    +

    SubjectAccessReviewStatus v1beta1 authorization

    + + + + + + + + + +
    FieldDescription
    allowed
    boolean
    Allowed is required. True if the action would be allowed, false otherwise.
    denied
    boolean
    Denied is optional. True if the action would be denied, otherwise false. If both allowed is false and denied is false, then the authorizer has no opinion on whether to authorize the action. Denied may not be true if Allowed is true.
    evaluationError
    string
    EvaluationError is an indication that some error occurred during the authorization check. It is entirely possible to get an error and be able to continue determine authorization status in spite of it. For instance, RBAC can be missing a role, but enough roles are still present and bound to reason about the request.
    reason
    string
    Reason is optional. It indicates why a request was allowed or denied.
    +

    Write Operations

    +

    Create

    +

    create a SubjectAccessReview

    +

    HTTP Request

    +POST /apis/authorization.k8s.io/v1beta1/subjectaccessreviews +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    dryRunWhen 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
    fieldManagerfieldManager 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.
    prettyIf 'true', then the output is pretty printed.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    SubjectAccessReview
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    SubjectAccessReview
    OK
    201
    SubjectAccessReview
    Created
    202
    SubjectAccessReview
    Accepted
    +

    SubjectRulesReviewStatus v1beta1 authorization.k8s.io

    + + + + + +
    GroupVersionKind
    authorization.k8s.iov1beta1SubjectRulesReviewStatus
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + + + +
    FieldDescription
    evaluationError
    string
    EvaluationError can appear in combination with Rules. It indicates an error occurred during rule evaluation, such as an authorizer that doesn't support rule evaluation, and that ResourceRules and/or NonResourceRules may be incomplete.
    incomplete
    boolean
    Incomplete is true when the rules returned by this call are incomplete. This is most commonly encountered when an authorizer, such as an external authorizer, doesn't support rules evaluation.
    nonResourceRules
    NonResourceRule array
    NonResourceRules is the list of actions the subject is allowed to perform on non-resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.
    resourceRules
    ResourceRule array
    ResourceRules is the list of actions the subject is allowed to perform on resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.
    +

    TokenRequest v1 storage.k8s.io

    + + + + + +
    GroupVersionKind
    storage.k8s.iov1TokenRequest
    +
    Other API versions of this object exist: +v1beta1 +
    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    audience
    string
    Audience is the intended audience of the token in "TokenRequestSpec". It will default to the audiences of kube apiserver.
    expirationSeconds
    integer
    ExpirationSeconds is the duration of validity of the token in "TokenRequestSpec". It has the same default value of "ExpirationSeconds" in "TokenRequestSpec".
    +

    TokenRequest v1beta1 storage.k8s.io

    + + + + + +
    GroupVersionKind
    storage.k8s.iov1beta1TokenRequest
    +
    Other API versions of this object exist: +v1 +v1 +
    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    audience
    string
    Audience is the intended audience of the token in "TokenRequestSpec". It will default to the audiences of kube apiserver.
    expirationSeconds
    integer
    ExpirationSeconds is the duration of validity of the token in "TokenRequestSpec". It has the same default value of "ExpirationSeconds" in "TokenRequestSpec"
    +

    TokenReview v1beta1 authentication.k8s.io

    + + + + + +
    GroupVersionKind
    authentication.k8s.iov1beta1TokenReview
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    spec
    TokenReviewSpec
    Spec holds information about the request being evaluated
    status
    TokenReviewStatus
    Status is filled in by the server and indicates whether the request can be authenticated.
    +

    TokenReviewSpec v1beta1 authentication

    + + + + + + + +
    FieldDescription
    audiences
    string array
    Audiences is a list of the identifiers that the resource server presented with the token identifies as. Audience-aware token authenticators will verify that the token was intended for at least one of the audiences in this list. If no audiences are provided, the audience will default to the audience of the Kubernetes apiserver.
    token
    string
    Token is the opaque bearer token.
    +

    TokenReviewStatus v1beta1 authentication

    + + + + + + + + + +
    FieldDescription
    audiences
    string array
    Audiences are audience identifiers chosen by the authenticator that are compatible with both the TokenReview and token. An identifier is any identifier in the intersection of the TokenReviewSpec audiences and the token's audiences. A client of the TokenReview API that sets the spec.audiences field should validate that a compatible audience identifier is returned in the status.audiences field to ensure that the TokenReview server is audience aware. If a TokenReview returns an empty status.audience field where status.authenticated is "true", the token is valid against the audience of the Kubernetes API server.
    authenticated
    boolean
    Authenticated indicates that the token was associated with a known user.
    error
    string
    Error indicates that the token couldn't be checked
    user
    UserInfo
    User is the UserInfo associated with the provided token.
    +

    Write Operations

    +

    Create

    +

    create a TokenReview

    +

    HTTP Request

    +POST /apis/authentication.k8s.io/v1beta1/tokenreviews +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    dryRunWhen 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
    fieldManagerfieldManager 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.
    prettyIf 'true', then the output is pretty printed.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    TokenReview
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    TokenReview
    OK
    201
    TokenReview
    Created
    202
    TokenReview
    Accepted
    +

    UserInfo v1beta1 authentication.k8s.io

    + + + + + +
    GroupVersionKind
    authentication.k8s.iov1beta1UserInfo
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + + + +
    FieldDescription
    extra
    object
    Any additional information provided by the authenticator.
    groups
    string array
    The names of groups this user is a part of.
    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.
    username
    string
    The name that uniquely identifies this user among all active users.
    +

    ValidatingWebhook v1beta1 admissionregistration.k8s.io

    + + + + + +
    GroupVersionKind
    admissionregistration.k8s.iov1beta1ValidatingWebhook
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + + + + + + + + + +
    FieldDescription
    admissionReviewVersions
    string array
    AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` versions the Webhook expects. API server will try to use first version in the list which it supports. If none of the versions specified in this list supported by API server, validation will fail for this object. If a persisted webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail and be subject to the failure policy. Default to `['v1beta1']`.
    clientConfig
    WebhookClientConfig
    ClientConfig defines how to communicate with the hook. Required
    failurePolicy
    string
    FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Ignore.
    matchPolicy
    string
    matchPolicy defines how the "rules" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". - Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the webhook. - Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the webhook. Defaults to "Exact"
    name
    string
    The name of the admission webhook. Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where "imagepolicy" is the name of the webhook, and kubernetes.io is the name of the organization. Required.
    namespaceSelector
    LabelSelector
    NamespaceSelector decides whether to run the webhook on an object based on whether the namespace for that object matches the selector. If the object itself is a namespace, the matching is performed on object.metadata.labels. If the object is another cluster scoped resource, it never skips the webhook. For example, to run the webhook on any objects whose namespace is not associated with "runlevel" of "0" or "1"; you will set the selector as follows: "namespaceSelector": { "matchExpressions": [ { "key": "runlevel", "operator": "NotIn", "values": [ "0", "1" ] } ] } If instead you want to only run the webhook on any objects whose namespace is associated with the "environment" of "prod" or "staging"; you will set the selector as follows: "namespaceSelector": { "matchExpressions": [ { "key": "environment", "operator": "In", "values": [ "prod", "staging" ] } ] } See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels for more examples of label selectors. Default to the empty LabelSelector, which matches everything.
    objectSelector
    LabelSelector
    ObjectSelector decides whether to run the webhook based on if the object has matching labels. objectSelector is evaluated against both the oldObject and newObject that would be sent to the webhook, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. Default to the empty LabelSelector, which matches everything.
    rules
    RuleWithOperations array
    Rules describes what operations on what resources/subresources the webhook cares about. The webhook cares about an operation if it matches _any_ Rule. However, in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks from putting the cluster in a state which cannot be recovered from without completely disabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects.
    sideEffects
    string
    SideEffects states whether this webhook has side effects. Acceptable values are: Unknown, None, Some, NoneOnDryRun Webhooks with side effects MUST implement a reconciliation system, since a request may be rejected by a future step in the admission chain and the side effects therefore need to be undone. Requests with the dryRun attribute will be auto-rejected if they match a webhook with sideEffects == Unknown or Some. Defaults to Unknown.
    timeoutSeconds
    integer
    TimeoutSeconds specifies the timeout for this webhook. After the timeout passes, the webhook call will be ignored or the API call will fail based on the failure policy. The timeout value must be between 1 and 30 seconds. Default to 30 seconds.
    +

    ValidatingWebhookConfiguration v1beta1 admissionregistration.k8s.io

    + + + + + +
    GroupVersionKind
    admissionregistration.k8s.iov1beta1ValidatingWebhookConfiguration
    +
    Other API versions of this object exist: +v1 +
    + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
    webhooks
    ValidatingWebhook array
    patch strategy: merge
    patch merge key: name
    Webhooks is a list of webhooks and the affected resources and operations.
    +

    ValidatingWebhookConfigurationList v1beta1 admissionregistration

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    ValidatingWebhookConfiguration array
    List of ValidatingWebhookConfiguration.
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    +

    Write Operations

    +

    Create

    +

    create a ValidatingWebhookConfiguration

    +

    HTTP Request

    +POST /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    ValidatingWebhookConfiguration
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    ValidatingWebhookConfiguration
    OK
    201
    ValidatingWebhookConfiguration
    Created
    202
    ValidatingWebhookConfiguration
    Accepted
    +

    Patch

    +

    partially update the specified ValidatingWebhookConfiguration

    +

    HTTP Request

    +PATCH /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the ValidatingWebhookConfiguration
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    ValidatingWebhookConfiguration
    OK
    +

    Replace

    +

    replace the specified ValidatingWebhookConfiguration

    +

    HTTP Request

    +PUT /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the ValidatingWebhookConfiguration
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    ValidatingWebhookConfiguration
    +

    Response

    + + + + + + +
    CodeDescription
    200
    ValidatingWebhookConfiguration
    OK
    201
    ValidatingWebhookConfiguration
    Created
    +

    Delete

    +

    delete a ValidatingWebhookConfiguration

    +

    HTTP Request

    +DELETE /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the ValidatingWebhookConfiguration
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Status
    OK
    202
    Status
    Accepted
    +

    Delete Collection

    +

    delete collection of ValidatingWebhookConfiguration

    +

    HTTP Request

    +DELETE /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified ValidatingWebhookConfiguration

    +

    HTTP Request

    +GET /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the ValidatingWebhookConfiguration
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    ValidatingWebhookConfiguration
    OK
    +

    List

    +

    list or watch objects of kind ValidatingWebhookConfiguration

    +

    HTTP Request

    +GET /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    ValidatingWebhookConfigurationList
    OK
    +

    Watch

    +

    watch changes to an object of kind ValidatingWebhookConfiguration. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/admissionregistration.k8s.io/v1beta1/watch/validatingwebhookconfigurations/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the ValidatingWebhookConfiguration
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of ValidatingWebhookConfiguration. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/admissionregistration.k8s.io/v1beta1/watch/validatingwebhookconfigurations +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    VolumeAttachment v1beta1 storage.k8s.io

    + + + + + +
    GroupVersionKind
    storage.k8s.iov1beta1VolumeAttachment
    +
    Other API versions of this object exist: +v1 +v1alpha1 +
    + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    spec
    VolumeAttachmentSpec
    Specification of the desired attach/detach volume behavior. Populated by the Kubernetes system.
    status
    VolumeAttachmentStatus
    Status of the VolumeAttachment request. Populated by the entity completing the attach or detach operation, i.e. the external-attacher.
    +

    VolumeAttachmentSpec v1beta1 storage

    + + + + + + + + +
    FieldDescription
    attacher
    string
    Attacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName().
    nodeName
    string
    The node that the volume should be attached to.
    source
    VolumeAttachmentSource
    Source represents the volume that should be attached.
    +

    VolumeAttachmentStatus v1beta1 storage

    + + + + + + + + + +
    FieldDescription
    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.
    attached
    boolean
    Indicates the volume is successfully attached. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
    attachmentMetadata
    object
    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.
    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.
    +

    VolumeAttachmentList v1beta1 storage

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    VolumeAttachment array
    Items is the list of VolumeAttachments
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    +

    Write Operations

    +

    Create

    +

    create a VolumeAttachment

    +

    HTTP Request

    +POST /apis/storage.k8s.io/v1beta1/volumeattachments +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    VolumeAttachment
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    VolumeAttachment
    OK
    201
    VolumeAttachment
    Created
    202
    VolumeAttachment
    Accepted
    +

    Patch

    +

    partially update the specified VolumeAttachment

    +

    HTTP Request

    +PATCH /apis/storage.k8s.io/v1beta1/volumeattachments/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the VolumeAttachment
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    VolumeAttachment
    OK
    +

    Replace

    +

    replace the specified VolumeAttachment

    +

    HTTP Request

    +PUT /apis/storage.k8s.io/v1beta1/volumeattachments/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the VolumeAttachment
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    VolumeAttachment
    +

    Response

    + + + + + + +
    CodeDescription
    200
    VolumeAttachment
    OK
    201
    VolumeAttachment
    Created
    +

    Delete

    +

    delete a VolumeAttachment

    +

    HTTP Request

    +DELETE /apis/storage.k8s.io/v1beta1/volumeattachments/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the VolumeAttachment
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    VolumeAttachment
    OK
    202
    VolumeAttachment
    Accepted
    +

    Delete Collection

    +

    delete collection of VolumeAttachment

    +

    HTTP Request

    +DELETE /apis/storage.k8s.io/v1beta1/volumeattachments +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified VolumeAttachment

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1beta1/volumeattachments/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the VolumeAttachment
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    VolumeAttachment
    OK
    +

    List

    +

    list or watch objects of kind VolumeAttachment

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1beta1/volumeattachments +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    VolumeAttachmentList
    OK
    +

    Watch

    +

    watch changes to an object of kind VolumeAttachment. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1beta1/watch/volumeattachments/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the VolumeAttachment
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of VolumeAttachment. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1beta1/watch/volumeattachments +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    VolumeAttachment v1alpha1 storage.k8s.io

    + + + + + +
    GroupVersionKind
    storage.k8s.iov1alpha1VolumeAttachment
    +
    Other API versions of this object exist: +v1 +v1beta1 +
    + + + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ObjectMeta
    Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    spec
    VolumeAttachmentSpec
    Specification of the desired attach/detach volume behavior. Populated by the Kubernetes system.
    status
    VolumeAttachmentStatus
    Status of the VolumeAttachment request. Populated by the entity completing the attach or detach operation, i.e. the external-attacher.
    +

    VolumeAttachmentSpec v1alpha1 storage

    + + + + + + + + +
    FieldDescription
    attacher
    string
    Attacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName().
    nodeName
    string
    The node that the volume should be attached to.
    source
    VolumeAttachmentSource
    Source represents the volume that should be attached.
    +

    VolumeAttachmentStatus v1alpha1 storage

    + + + + + + + + + +
    FieldDescription
    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.
    attached
    boolean
    Indicates the volume is successfully attached. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
    attachmentMetadata
    object
    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.
    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.
    +

    VolumeAttachmentList v1alpha1 storage

    + + + + + + + + +
    FieldDescription
    apiVersion
    string
    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
    items
    VolumeAttachment array
    Items is the list of VolumeAttachments
    kind
    string
    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
    metadata
    ListMeta
    Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    +

    Write Operations

    +

    Create

    +

    create a VolumeAttachment

    +

    HTTP Request

    +POST /apis/storage.k8s.io/v1alpha1/volumeattachments +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    VolumeAttachment
    +

    Response

    + + + + + + + +
    CodeDescription
    200
    VolumeAttachment
    OK
    201
    VolumeAttachment
    Created
    202
    VolumeAttachment
    Accepted
    +

    Patch

    +

    partially update the specified VolumeAttachment

    +

    HTTP Request

    +PATCH /apis/storage.k8s.io/v1alpha1/volumeattachments/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the VolumeAttachment
    +

    Query Parameters

    + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
    forceForce 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Patch
    +

    Response

    + + + + + +
    CodeDescription
    200
    VolumeAttachment
    OK
    +

    Replace

    +

    replace the specified VolumeAttachment

    +

    HTTP Request

    +PUT /apis/storage.k8s.io/v1alpha1/volumeattachments/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the VolumeAttachment
    +

    Query Parameters

    + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    fieldManagerfieldManager 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    VolumeAttachment
    +

    Response

    + + + + + + +
    CodeDescription
    200
    VolumeAttachment
    OK
    201
    VolumeAttachment
    Created
    +

    Delete

    +

    delete a VolumeAttachment

    +

    HTTP Request

    +DELETE /apis/storage.k8s.io/v1alpha1/volumeattachments/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the VolumeAttachment
    +

    Query Parameters

    + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    dryRunWhen 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
    gracePeriodSecondsThe 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + + +
    CodeDescription
    200
    VolumeAttachment
    OK
    202
    VolumeAttachment
    Accepted
    +

    Delete Collection

    +

    delete collection of VolumeAttachment

    +

    HTTP Request

    +DELETE /apis/storage.k8s.io/v1alpha1/volumeattachments +

    Query Parameters

    + + + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    dryRunWhen 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
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    gracePeriodSecondsThe 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.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
    propagationPolicyWhether 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    DeleteOptions
    +

    Response

    + + + + + +
    CodeDescription
    200
    Status
    OK
    +

    Read Operations

    +

    Read

    +

    read the specified VolumeAttachment

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1alpha1/volumeattachments/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the VolumeAttachment
    +

    Query Parameters

    + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    +

    Response

    + + + + + +
    CodeDescription
    200
    VolumeAttachment
    OK
    +

    List

    +

    list or watch objects of kind VolumeAttachment

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1alpha1/volumeattachments +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    prettyIf 'true', then the output is pretty printed.
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    VolumeAttachmentList
    OK
    +

    Watch

    +

    watch changes to an object of kind VolumeAttachment. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1alpha1/watch/volumeattachments/{name} +

    Path Parameters

    + + + + + +
    ParameterDescription
    namename of the VolumeAttachment
    +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    Watch List

    +

    watch individual changes to a list of VolumeAttachment. deprecated: use the 'watch' parameter with a list operation instead.

    +

    HTTP Request

    +GET /apis/storage.k8s.io/v1alpha1/watch/volumeattachments +

    Query Parameters

    + + + + + + + + + + + + + + +
    ParameterDescription
    allowWatchBookmarksallowWatchBookmarks 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. 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.
    prettyIf 'true', then the output is pretty printed.
    resourceVersionresourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    resourceVersionMatchresourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
    timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
    watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
    +

    Response

    + + + + + +
    CodeDescription
    200
    WatchEvent
    OK
    +

    VolumeAttachmentSource v1beta1 storage.k8s.io

    + + + + + +
    GroupVersionKind
    storage.k8s.iov1beta1VolumeAttachmentSource
    +
    Other API versions of this object exist: +v1 +v1alpha1 +
    + + + + + + + +
    FieldDescription
    inlineVolumeSpec
    PersistentVolumeSpec
    inlineVolumeSpec contains all the information necessary to attach a persistent volume defined by a pod's inline VolumeSource. This field is populated only for the CSIMigration feature. It contains translated fields from a pod's inline VolumeSource to a PersistentVolumeSpec. This field is beta-level and is only honored by servers that enabled the CSIMigration feature.
    persistentVolumeName
    string
    Name of the persistent volume to attach.
    +

    VolumeAttachmentSource v1alpha1 storage.k8s.io

    + + + + + +
    GroupVersionKind
    storage.k8s.iov1alpha1VolumeAttachmentSource
    +
    Other API versions of this object exist: +v1 +v1beta1 +
    + + + + + + + +
    FieldDescription
    inlineVolumeSpec
    PersistentVolumeSpec
    inlineVolumeSpec contains all the information necessary to attach a persistent volume defined by a pod's inline VolumeSource. This field is populated only for the CSIMigration feature. It contains translated fields from a pod's inline VolumeSource to a PersistentVolumeSpec. This field is alpha-level and is only honored by servers that enabled the CSIMigration feature.
    persistentVolumeName
    string
    Name of the persistent volume to attach.
    +

    VolumeError v1beta1 storage.k8s.io

    + + + + + +
    GroupVersionKind
    storage.k8s.iov1beta1VolumeError
    +
    Other API versions of this object exist: +v1 +v1alpha1 +
    + + + + + + + +
    FieldDescription
    message
    string
    String detailing the error encountered during Attach or Detach operation. This string may be logged, so it should not contain sensitive information.
    time
    Time
    Time the error was encountered.
    +

    VolumeError v1alpha1 storage.k8s.io

    + + + + + +
    GroupVersionKind
    storage.k8s.iov1alpha1VolumeError
    +
    Other API versions of this object exist: +v1 +v1beta1 +
    + + + + + + + +
    FieldDescription
    message
    string
    String detailing the error encountered during Attach or Detach operation. This string maybe logged, so it should not contain sensitive information.
    time
    Time
    Time the error was encountered.
    +

    VolumeNodeResources v1beta1 storage.k8s.io

    + + + + + +
    GroupVersionKind
    storage.k8s.iov1beta1VolumeNodeResources
    +
    Other API versions of this object exist: +v1 +
    +
    Appears In: + +
    + + + + + +
    FieldDescription
    count
    integer
    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 nil, then the supported number of volumes on this node is unbounded.
    +

    WebhookClientConfig v1 apiextensions.k8s.io

    + + + + + +
    GroupVersionKind
    apiextensions.k8s.iov1WebhookClientConfig
    +
    Other API versions of this object exist: +v1beta1 +v1beta1 +
    + + + + + + + + +
    FieldDescription
    caBundle
    string
    caBundle is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. If unspecified, system trust roots on the apiserver are used.
    service
    ServiceReference
    service is a reference to the service for this webhook. Either service or url must be specified. If the webhook is running within the cluster, then you should use `service`.
    url
    string
    url gives the location of the webhook, in standard URL form (`scheme://host:port/path`). Exactly one of `url` or `service` must be specified. The `host` should not refer to a service running in the cluster; use the `service` field instead. The host might be resolved via external DNS in some apiservers (e.g., `kube-apiserver` cannot resolve in-cluster DNS as that would be a layering violation). `host` may also be an IP address. Please note that using `localhost` or `127.0.0.1` as a `host` is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster. The scheme must be "https"; the URL must begin with "https://". A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier. Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either.
    +

    WebhookClientConfig v1beta1 admissionregistration.k8s.io

    + + + + + +
    GroupVersionKind
    admissionregistration.k8s.iov1beta1WebhookClientConfig
    +
    Other API versions of this object exist: +v1 +v1 +
    + + + + + + + + +
    FieldDescription
    caBundle
    string
    `caBundle` is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. If unspecified, system trust roots on the apiserver are used.
    service
    ServiceReference
    `service` is a reference to the service for this webhook. Either `service` or `url` must be specified. If the webhook is running within the cluster, then you should use `service`.
    url
    string
    `url` gives the location of the webhook, in standard URL form (`scheme://host:port/path`). Exactly one of `url` or `service` must be specified. The `host` should not refer to a service running in the cluster; use the `service` field instead. The host might be resolved via external DNS in some apiservers (e.g., `kube-apiserver` cannot resolve in-cluster DNS as that would be a layering violation). `host` may also be an IP address. Please note that using `localhost` or `127.0.0.1` as a `host` is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster. The scheme must be "https"; the URL must begin with "https://". A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier. Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either.
    +

    WebhookClientConfig v1beta1 apiextensions.k8s.io

    + + + + + +
    GroupVersionKind
    apiextensions.k8s.iov1beta1WebhookClientConfig
    +
    Other API versions of this object exist: +v1 +v1 +
    + + + + + + + + +
    FieldDescription
    caBundle
    string
    caBundle is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. If unspecified, system trust roots on the apiserver are used.
    service
    ServiceReference
    service is a reference to the service for this webhook. Either service or url must be specified. If the webhook is running within the cluster, then you should use `service`.
    url
    string
    url gives the location of the webhook, in standard URL form (`scheme://host:port/path`). Exactly one of `url` or `service` must be specified. The `host` should not refer to a service running in the cluster; use the `service` field instead. The host might be resolved via external DNS in some apiservers (e.g., `kube-apiserver` cannot resolve in-cluster DNS as that would be a layering violation). `host` may also be an IP address. Please note that using `localhost` or `127.0.0.1` as a `host` is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster. The scheme must be "https"; the URL must begin with "https://". A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier. Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either.
    + +
    +
    +
    + + + + + + + diff --git a/static/docs/reference/generated/kubernetes-api/v1.21/js/navData.js b/static/docs/reference/generated/kubernetes-api/v1.21/js/navData.js new file mode 100644 index 0000000000..61546bfa6f --- /dev/null +++ b/static/docs/reference/generated/kubernetes-api/v1.21/js/navData.js @@ -0,0 +1 @@ +(function(){navData={"toc":[{"section":"webhookclientconfig-v1beta1-apiextensions-k8s-io","subsections":[]},{"section":"webhookclientconfig-v1beta1-admissionregistration-k8s-io","subsections":[]},{"section":"webhookclientconfig-v1-apiextensions-k8s-io","subsections":[]},{"section":"volumenoderesources-v1beta1-storage-k8s-io","subsections":[]},{"section":"volumeerror-v1alpha1-storage-k8s-io","subsections":[]},{"section":"volumeerror-v1beta1-storage-k8s-io","subsections":[]},{"section":"volumeattachmentsource-v1alpha1-storage-k8s-io","subsections":[]},{"section":"volumeattachmentsource-v1beta1-storage-k8s-io","subsections":[]},{"section":"volumeattachment-v1alpha1-storage-k8s-io","subsections":[{"section":"-strong-read-operations-volumeattachment-v1alpha1-storage-k8s-io-strong-","subsections":[{"section":"watch-list-volumeattachment-v1alpha1-storage-k8s-io","subsections":[]},{"section":"watch-volumeattachment-v1alpha1-storage-k8s-io","subsections":[]},{"section":"list-volumeattachment-v1alpha1-storage-k8s-io","subsections":[]},{"section":"read-volumeattachment-v1alpha1-storage-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-volumeattachment-v1alpha1-storage-k8s-io-strong-","subsections":[{"section":"delete-collection-volumeattachment-v1alpha1-storage-k8s-io","subsections":[]},{"section":"delete-volumeattachment-v1alpha1-storage-k8s-io","subsections":[]},{"section":"replace-volumeattachment-v1alpha1-storage-k8s-io","subsections":[]},{"section":"patch-volumeattachment-v1alpha1-storage-k8s-io","subsections":[]},{"section":"create-volumeattachment-v1alpha1-storage-k8s-io","subsections":[]}]}]},{"section":"volumeattachment-v1beta1-storage-k8s-io","subsections":[{"section":"-strong-read-operations-volumeattachment-v1beta1-storage-k8s-io-strong-","subsections":[{"section":"watch-list-volumeattachment-v1beta1-storage-k8s-io","subsections":[]},{"section":"watch-volumeattachment-v1beta1-storage-k8s-io","subsections":[]},{"section":"list-volumeattachment-v1beta1-storage-k8s-io","subsections":[]},{"section":"read-volumeattachment-v1beta1-storage-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-volumeattachment-v1beta1-storage-k8s-io-strong-","subsections":[{"section":"delete-collection-volumeattachment-v1beta1-storage-k8s-io","subsections":[]},{"section":"delete-volumeattachment-v1beta1-storage-k8s-io","subsections":[]},{"section":"replace-volumeattachment-v1beta1-storage-k8s-io","subsections":[]},{"section":"patch-volumeattachment-v1beta1-storage-k8s-io","subsections":[]},{"section":"create-volumeattachment-v1beta1-storage-k8s-io","subsections":[]}]}]},{"section":"validatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","subsections":[{"section":"-strong-read-operations-validatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io-strong-","subsections":[{"section":"watch-list-validatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","subsections":[]},{"section":"watch-validatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","subsections":[]},{"section":"list-validatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","subsections":[]},{"section":"read-validatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-validatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io-strong-","subsections":[{"section":"delete-collection-validatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","subsections":[]},{"section":"delete-validatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","subsections":[]},{"section":"replace-validatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","subsections":[]},{"section":"patch-validatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","subsections":[]},{"section":"create-validatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","subsections":[]}]}]},{"section":"validatingwebhook-v1beta1-admissionregistration-k8s-io","subsections":[]},{"section":"userinfo-v1beta1-authentication-k8s-io","subsections":[]},{"section":"tokenreview-v1beta1-authentication-k8s-io","subsections":[{"section":"-strong-write-operations-tokenreview-v1beta1-authentication-k8s-io-strong-","subsections":[{"section":"create-tokenreview-v1beta1-authentication-k8s-io","subsections":[]}]}]},{"section":"tokenrequest-v1beta1-storage-k8s-io","subsections":[]},{"section":"tokenrequest-v1-storage-k8s-io","subsections":[]},{"section":"subjectrulesreviewstatus-v1beta1-authorization-k8s-io","subsections":[]},{"section":"subjectaccessreview-v1beta1-authorization-k8s-io","subsections":[{"section":"-strong-write-operations-subjectaccessreview-v1beta1-authorization-k8s-io-strong-","subsections":[{"section":"create-subjectaccessreview-v1beta1-authorization-k8s-io","subsections":[]}]}]},{"section":"subject-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"subject-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"subject-v1-rbac-authorization-k8s-io","subsections":[]},{"section":"storageclass-v1beta1-storage-k8s-io","subsections":[{"section":"-strong-read-operations-storageclass-v1beta1-storage-k8s-io-strong-","subsections":[{"section":"watch-list-storageclass-v1beta1-storage-k8s-io","subsections":[]},{"section":"watch-storageclass-v1beta1-storage-k8s-io","subsections":[]},{"section":"list-storageclass-v1beta1-storage-k8s-io","subsections":[]},{"section":"read-storageclass-v1beta1-storage-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-storageclass-v1beta1-storage-k8s-io-strong-","subsections":[{"section":"delete-collection-storageclass-v1beta1-storage-k8s-io","subsections":[]},{"section":"delete-storageclass-v1beta1-storage-k8s-io","subsections":[]},{"section":"replace-storageclass-v1beta1-storage-k8s-io","subsections":[]},{"section":"patch-storageclass-v1beta1-storage-k8s-io","subsections":[]},{"section":"create-storageclass-v1beta1-storage-k8s-io","subsections":[]}]}]},{"section":"servicereference-v1beta1-apiregistration-k8s-io","subsections":[]},{"section":"servicereference-v1beta1-apiextensions-k8s-io","subsections":[]},{"section":"servicereference-v1beta1-admissionregistration-k8s-io","subsections":[]},{"section":"servicereference-v1-apiregistration-k8s-io","subsections":[]},{"section":"servicereference-v1-apiextensions-k8s-io","subsections":[]},{"section":"selfsubjectrulesreview-v1beta1-authorization-k8s-io","subsections":[{"section":"-strong-write-operations-selfsubjectrulesreview-v1beta1-authorization-k8s-io-strong-","subsections":[{"section":"create-selfsubjectrulesreview-v1beta1-authorization-k8s-io","subsections":[]}]}]},{"section":"selfsubjectaccessreview-v1beta1-authorization-k8s-io","subsections":[{"section":"-strong-write-operations-selfsubjectaccessreview-v1beta1-authorization-k8s-io-strong-","subsections":[{"section":"create-selfsubjectaccessreview-v1beta1-authorization-k8s-io","subsections":[]}]}]},{"section":"scheduling-v1alpha1-node-k8s-io","subsections":[]},{"section":"scheduling-v1beta1-node-k8s-io","subsections":[]},{"section":"runtimeclass-v1alpha1-node-k8s-io","subsections":[{"section":"-strong-read-operations-runtimeclass-v1alpha1-node-k8s-io-strong-","subsections":[{"section":"watch-list-runtimeclass-v1alpha1-node-k8s-io","subsections":[]},{"section":"watch-runtimeclass-v1alpha1-node-k8s-io","subsections":[]},{"section":"list-runtimeclass-v1alpha1-node-k8s-io","subsections":[]},{"section":"read-runtimeclass-v1alpha1-node-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-runtimeclass-v1alpha1-node-k8s-io-strong-","subsections":[{"section":"delete-collection-runtimeclass-v1alpha1-node-k8s-io","subsections":[]},{"section":"delete-runtimeclass-v1alpha1-node-k8s-io","subsections":[]},{"section":"replace-runtimeclass-v1alpha1-node-k8s-io","subsections":[]},{"section":"patch-runtimeclass-v1alpha1-node-k8s-io","subsections":[]},{"section":"create-runtimeclass-v1alpha1-node-k8s-io","subsections":[]}]}]},{"section":"runtimeclass-v1beta1-node-k8s-io","subsections":[{"section":"-strong-read-operations-runtimeclass-v1beta1-node-k8s-io-strong-","subsections":[{"section":"watch-list-runtimeclass-v1beta1-node-k8s-io","subsections":[]},{"section":"watch-runtimeclass-v1beta1-node-k8s-io","subsections":[]},{"section":"list-runtimeclass-v1beta1-node-k8s-io","subsections":[]},{"section":"read-runtimeclass-v1beta1-node-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-runtimeclass-v1beta1-node-k8s-io-strong-","subsections":[{"section":"delete-collection-runtimeclass-v1beta1-node-k8s-io","subsections":[]},{"section":"delete-runtimeclass-v1beta1-node-k8s-io","subsections":[]},{"section":"replace-runtimeclass-v1beta1-node-k8s-io","subsections":[]},{"section":"patch-runtimeclass-v1beta1-node-k8s-io","subsections":[]},{"section":"create-runtimeclass-v1beta1-node-k8s-io","subsections":[]}]}]},{"section":"rulewithoperations-v1beta1-admissionregistration-k8s-io","subsections":[]},{"section":"roleref-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"roleref-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"rolebinding-v1alpha1-rbac-authorization-k8s-io","subsections":[{"section":"-strong-read-operations-rolebinding-v1alpha1-rbac-authorization-k8s-io-strong-","subsections":[{"section":"watch-list-all-namespaces-rolebinding-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"watch-list-rolebinding-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"watch-rolebinding-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"list-all-namespaces-rolebinding-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"list-rolebinding-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"read-rolebinding-v1alpha1-rbac-authorization-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-rolebinding-v1alpha1-rbac-authorization-k8s-io-strong-","subsections":[{"section":"delete-collection-rolebinding-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"delete-rolebinding-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"replace-rolebinding-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"patch-rolebinding-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"create-rolebinding-v1alpha1-rbac-authorization-k8s-io","subsections":[]}]}]},{"section":"rolebinding-v1beta1-rbac-authorization-k8s-io","subsections":[{"section":"-strong-read-operations-rolebinding-v1beta1-rbac-authorization-k8s-io-strong-","subsections":[{"section":"watch-list-all-namespaces-rolebinding-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"watch-list-rolebinding-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"watch-rolebinding-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"list-all-namespaces-rolebinding-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"list-rolebinding-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"read-rolebinding-v1beta1-rbac-authorization-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-rolebinding-v1beta1-rbac-authorization-k8s-io-strong-","subsections":[{"section":"delete-collection-rolebinding-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"delete-rolebinding-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"replace-rolebinding-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"patch-rolebinding-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"create-rolebinding-v1beta1-rbac-authorization-k8s-io","subsections":[]}]}]},{"section":"role-v1alpha1-rbac-authorization-k8s-io","subsections":[{"section":"-strong-read-operations-role-v1alpha1-rbac-authorization-k8s-io-strong-","subsections":[{"section":"watch-list-all-namespaces-role-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"watch-list-role-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"watch-role-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"list-all-namespaces-role-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"list-role-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"read-role-v1alpha1-rbac-authorization-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-role-v1alpha1-rbac-authorization-k8s-io-strong-","subsections":[{"section":"delete-collection-role-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"delete-role-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"replace-role-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"patch-role-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"create-role-v1alpha1-rbac-authorization-k8s-io","subsections":[]}]}]},{"section":"role-v1beta1-rbac-authorization-k8s-io","subsections":[{"section":"-strong-read-operations-role-v1beta1-rbac-authorization-k8s-io-strong-","subsections":[{"section":"watch-list-all-namespaces-role-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"watch-list-role-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"watch-role-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"list-all-namespaces-role-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"list-role-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"read-role-v1beta1-rbac-authorization-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-role-v1beta1-rbac-authorization-k8s-io-strong-","subsections":[{"section":"delete-collection-role-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"delete-role-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"replace-role-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"patch-role-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"create-role-v1beta1-rbac-authorization-k8s-io","subsections":[]}]}]},{"section":"resourcerule-v1beta1-authorization-k8s-io","subsections":[]},{"section":"resourcemetricstatus-v2beta1-autoscaling","subsections":[]},{"section":"resourcemetricsource-v2beta1-autoscaling","subsections":[]},{"section":"resourceattributes-v1beta1-authorization-k8s-io","subsections":[]},{"section":"priorityclass-v1alpha1-scheduling-k8s-io","subsections":[{"section":"-strong-read-operations-priorityclass-v1alpha1-scheduling-k8s-io-strong-","subsections":[{"section":"watch-list-priorityclass-v1alpha1-scheduling-k8s-io","subsections":[]},{"section":"watch-priorityclass-v1alpha1-scheduling-k8s-io","subsections":[]},{"section":"list-priorityclass-v1alpha1-scheduling-k8s-io","subsections":[]},{"section":"read-priorityclass-v1alpha1-scheduling-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-priorityclass-v1alpha1-scheduling-k8s-io-strong-","subsections":[{"section":"delete-collection-priorityclass-v1alpha1-scheduling-k8s-io","subsections":[]},{"section":"delete-priorityclass-v1alpha1-scheduling-k8s-io","subsections":[]},{"section":"replace-priorityclass-v1alpha1-scheduling-k8s-io","subsections":[]},{"section":"patch-priorityclass-v1alpha1-scheduling-k8s-io","subsections":[]},{"section":"create-priorityclass-v1alpha1-scheduling-k8s-io","subsections":[]}]}]},{"section":"priorityclass-v1beta1-scheduling-k8s-io","subsections":[{"section":"-strong-read-operations-priorityclass-v1beta1-scheduling-k8s-io-strong-","subsections":[{"section":"watch-list-priorityclass-v1beta1-scheduling-k8s-io","subsections":[]},{"section":"watch-priorityclass-v1beta1-scheduling-k8s-io","subsections":[]},{"section":"list-priorityclass-v1beta1-scheduling-k8s-io","subsections":[]},{"section":"read-priorityclass-v1beta1-scheduling-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-priorityclass-v1beta1-scheduling-k8s-io-strong-","subsections":[{"section":"delete-collection-priorityclass-v1beta1-scheduling-k8s-io","subsections":[]},{"section":"delete-priorityclass-v1beta1-scheduling-k8s-io","subsections":[]},{"section":"replace-priorityclass-v1beta1-scheduling-k8s-io","subsections":[]},{"section":"patch-priorityclass-v1beta1-scheduling-k8s-io","subsections":[]},{"section":"create-priorityclass-v1beta1-scheduling-k8s-io","subsections":[]}]}]},{"section":"policyrule-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"policyrule-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"podsmetricstatus-v2beta1-autoscaling","subsections":[]},{"section":"podsmetricsource-v2beta1-autoscaling","subsections":[]},{"section":"poddisruptionbudget-v1beta1-policy","subsections":[{"section":"-strong-status-operations-poddisruptionbudget-v1beta1-policy-strong-","subsections":[{"section":"replace-status-poddisruptionbudget-v1beta1-policy","subsections":[]},{"section":"read-status-poddisruptionbudget-v1beta1-policy","subsections":[]},{"section":"patch-status-poddisruptionbudget-v1beta1-policy","subsections":[]}]},{"section":"-strong-read-operations-poddisruptionbudget-v1beta1-policy-strong-","subsections":[{"section":"watch-list-all-namespaces-poddisruptionbudget-v1beta1-policy","subsections":[]},{"section":"watch-list-poddisruptionbudget-v1beta1-policy","subsections":[]},{"section":"watch-poddisruptionbudget-v1beta1-policy","subsections":[]},{"section":"list-all-namespaces-poddisruptionbudget-v1beta1-policy","subsections":[]},{"section":"list-poddisruptionbudget-v1beta1-policy","subsections":[]},{"section":"read-poddisruptionbudget-v1beta1-policy","subsections":[]}]},{"section":"-strong-write-operations-poddisruptionbudget-v1beta1-policy-strong-","subsections":[{"section":"delete-collection-poddisruptionbudget-v1beta1-policy","subsections":[]},{"section":"delete-poddisruptionbudget-v1beta1-policy","subsections":[]},{"section":"replace-poddisruptionbudget-v1beta1-policy","subsections":[]},{"section":"patch-poddisruptionbudget-v1beta1-policy","subsections":[]},{"section":"create-poddisruptionbudget-v1beta1-policy","subsections":[]}]}]},{"section":"overhead-v1alpha1-node-k8s-io","subsections":[]},{"section":"overhead-v1beta1-node-k8s-io","subsections":[]},{"section":"objectmetricstatus-v2beta1-autoscaling","subsections":[]},{"section":"objectmetricsource-v2beta1-autoscaling","subsections":[]},{"section":"nonresourcerule-v1beta1-authorization-k8s-io","subsections":[]},{"section":"nonresourceattributes-v1beta1-authorization-k8s-io","subsections":[]},{"section":"mutatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","subsections":[{"section":"-strong-read-operations-mutatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io-strong-","subsections":[{"section":"watch-list-mutatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","subsections":[]},{"section":"watch-mutatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","subsections":[]},{"section":"list-mutatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","subsections":[]},{"section":"read-mutatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-mutatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io-strong-","subsections":[{"section":"delete-collection-mutatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","subsections":[]},{"section":"delete-mutatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","subsections":[]},{"section":"replace-mutatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","subsections":[]},{"section":"patch-mutatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","subsections":[]},{"section":"create-mutatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","subsections":[]}]}]},{"section":"mutatingwebhook-v1beta1-admissionregistration-k8s-io","subsections":[]},{"section":"metricstatus-v2beta1-autoscaling","subsections":[]},{"section":"metricspec-v2beta1-autoscaling","subsections":[]},{"section":"localsubjectaccessreview-v1beta1-authorization-k8s-io","subsections":[{"section":"-strong-write-operations-localsubjectaccessreview-v1beta1-authorization-k8s-io-strong-","subsections":[{"section":"create-localsubjectaccessreview-v1beta1-authorization-k8s-io","subsections":[]}]}]},{"section":"lease-v1beta1-coordination-k8s-io","subsections":[{"section":"-strong-read-operations-lease-v1beta1-coordination-k8s-io-strong-","subsections":[{"section":"watch-list-all-namespaces-lease-v1beta1-coordination-k8s-io","subsections":[]},{"section":"watch-list-lease-v1beta1-coordination-k8s-io","subsections":[]},{"section":"watch-lease-v1beta1-coordination-k8s-io","subsections":[]},{"section":"list-all-namespaces-lease-v1beta1-coordination-k8s-io","subsections":[]},{"section":"list-lease-v1beta1-coordination-k8s-io","subsections":[]},{"section":"read-lease-v1beta1-coordination-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-lease-v1beta1-coordination-k8s-io-strong-","subsections":[{"section":"delete-collection-lease-v1beta1-coordination-k8s-io","subsections":[]},{"section":"delete-lease-v1beta1-coordination-k8s-io","subsections":[]},{"section":"replace-lease-v1beta1-coordination-k8s-io","subsections":[]},{"section":"patch-lease-v1beta1-coordination-k8s-io","subsections":[]},{"section":"create-lease-v1beta1-coordination-k8s-io","subsections":[]}]}]},{"section":"jobtemplatespec-v1beta1-batch","subsections":[]},{"section":"jsonschemapropsorbool-v1beta1-apiextensions-k8s-io","subsections":[]},{"section":"jsonschemapropsorarray-v1beta1-apiextensions-k8s-io","subsections":[]},{"section":"jsonschemaprops-v1beta1-apiextensions-k8s-io","subsections":[]},{"section":"json-v1beta1-apiextensions-k8s-io","subsections":[]},{"section":"ingresstls-v1beta1-networking-k8s-io","subsections":[]},{"section":"ingresstls-v1beta1-extensions","subsections":[]},{"section":"ingressrule-v1beta1-networking-k8s-io","subsections":[]},{"section":"ingressrule-v1beta1-extensions","subsections":[]},{"section":"ingressclassparametersreference-v1beta1-networking-k8s-io","subsections":[]},{"section":"ingressclass-v1beta1-networking-k8s-io","subsections":[{"section":"-strong-read-operations-ingressclass-v1beta1-networking-k8s-io-strong-","subsections":[{"section":"watch-list-ingressclass-v1beta1-networking-k8s-io","subsections":[]},{"section":"watch-ingressclass-v1beta1-networking-k8s-io","subsections":[]},{"section":"list-ingressclass-v1beta1-networking-k8s-io","subsections":[]},{"section":"read-ingressclass-v1beta1-networking-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-ingressclass-v1beta1-networking-k8s-io-strong-","subsections":[{"section":"delete-collection-ingressclass-v1beta1-networking-k8s-io","subsections":[]},{"section":"delete-ingressclass-v1beta1-networking-k8s-io","subsections":[]},{"section":"replace-ingressclass-v1beta1-networking-k8s-io","subsections":[]},{"section":"patch-ingressclass-v1beta1-networking-k8s-io","subsections":[]},{"section":"create-ingressclass-v1beta1-networking-k8s-io","subsections":[]}]}]},{"section":"ingressbackend-v1beta1-networking-k8s-io","subsections":[]},{"section":"ingressbackend-v1beta1-extensions","subsections":[]},{"section":"ingress-v1beta1-networking-k8s-io","subsections":[{"section":"-strong-status-operations-ingress-v1beta1-networking-k8s-io-strong-","subsections":[{"section":"replace-status-ingress-v1beta1-networking-k8s-io","subsections":[]},{"section":"read-status-ingress-v1beta1-networking-k8s-io","subsections":[]},{"section":"patch-status-ingress-v1beta1-networking-k8s-io","subsections":[]}]},{"section":"-strong-read-operations-ingress-v1beta1-networking-k8s-io-strong-","subsections":[{"section":"watch-list-all-namespaces-ingress-v1beta1-networking-k8s-io","subsections":[]},{"section":"watch-list-ingress-v1beta1-networking-k8s-io","subsections":[]},{"section":"watch-ingress-v1beta1-networking-k8s-io","subsections":[]},{"section":"list-all-namespaces-ingress-v1beta1-networking-k8s-io","subsections":[]},{"section":"list-ingress-v1beta1-networking-k8s-io","subsections":[]},{"section":"read-ingress-v1beta1-networking-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-ingress-v1beta1-networking-k8s-io-strong-","subsections":[{"section":"delete-collection-ingress-v1beta1-networking-k8s-io","subsections":[]},{"section":"delete-ingress-v1beta1-networking-k8s-io","subsections":[]},{"section":"replace-ingress-v1beta1-networking-k8s-io","subsections":[]},{"section":"patch-ingress-v1beta1-networking-k8s-io","subsections":[]},{"section":"create-ingress-v1beta1-networking-k8s-io","subsections":[]}]}]},{"section":"ingress-v1beta1-extensions","subsections":[{"section":"-strong-status-operations-ingress-v1beta1-extensions-strong-","subsections":[{"section":"replace-status-ingress-v1beta1-extensions","subsections":[]},{"section":"read-status-ingress-v1beta1-extensions","subsections":[]},{"section":"patch-status-ingress-v1beta1-extensions","subsections":[]}]},{"section":"-strong-read-operations-ingress-v1beta1-extensions-strong-","subsections":[{"section":"watch-list-all-namespaces-ingress-v1beta1-extensions","subsections":[]},{"section":"watch-list-ingress-v1beta1-extensions","subsections":[]},{"section":"watch-ingress-v1beta1-extensions","subsections":[]},{"section":"list-all-namespaces-ingress-v1beta1-extensions","subsections":[]},{"section":"list-ingress-v1beta1-extensions","subsections":[]},{"section":"read-ingress-v1beta1-extensions","subsections":[]}]},{"section":"-strong-write-operations-ingress-v1beta1-extensions-strong-","subsections":[{"section":"delete-collection-ingress-v1beta1-extensions","subsections":[]},{"section":"delete-ingress-v1beta1-extensions","subsections":[]},{"section":"replace-ingress-v1beta1-extensions","subsections":[]},{"section":"patch-ingress-v1beta1-extensions","subsections":[]},{"section":"create-ingress-v1beta1-extensions","subsections":[]}]}]},{"section":"horizontalpodautoscalercondition-v2beta1-autoscaling","subsections":[]},{"section":"horizontalpodautoscaler-v2beta1-autoscaling","subsections":[{"section":"-strong-status-operations-horizontalpodautoscaler-v2beta1-autoscaling-strong-","subsections":[{"section":"replace-status-horizontalpodautoscaler-v2beta1-autoscaling","subsections":[]},{"section":"read-status-horizontalpodautoscaler-v2beta1-autoscaling","subsections":[]},{"section":"patch-status-horizontalpodautoscaler-v2beta1-autoscaling","subsections":[]}]},{"section":"-strong-read-operations-horizontalpodautoscaler-v2beta1-autoscaling-strong-","subsections":[{"section":"watch-list-all-namespaces-horizontalpodautoscaler-v2beta1-autoscaling","subsections":[]},{"section":"watch-list-horizontalpodautoscaler-v2beta1-autoscaling","subsections":[]},{"section":"watch-horizontalpodautoscaler-v2beta1-autoscaling","subsections":[]},{"section":"list-all-namespaces-horizontalpodautoscaler-v2beta1-autoscaling","subsections":[]},{"section":"list-horizontalpodautoscaler-v2beta1-autoscaling","subsections":[]},{"section":"read-horizontalpodautoscaler-v2beta1-autoscaling","subsections":[]}]},{"section":"-strong-write-operations-horizontalpodautoscaler-v2beta1-autoscaling-strong-","subsections":[{"section":"delete-collection-horizontalpodautoscaler-v2beta1-autoscaling","subsections":[]},{"section":"delete-horizontalpodautoscaler-v2beta1-autoscaling","subsections":[]},{"section":"replace-horizontalpodautoscaler-v2beta1-autoscaling","subsections":[]},{"section":"patch-horizontalpodautoscaler-v2beta1-autoscaling","subsections":[]},{"section":"create-horizontalpodautoscaler-v2beta1-autoscaling","subsections":[]}]}]},{"section":"horizontalpodautoscaler-v2beta2-autoscaling","subsections":[{"section":"-strong-status-operations-horizontalpodautoscaler-v2beta2-autoscaling-strong-","subsections":[{"section":"replace-status-horizontalpodautoscaler-v2beta2-autoscaling","subsections":[]},{"section":"read-status-horizontalpodautoscaler-v2beta2-autoscaling","subsections":[]},{"section":"patch-status-horizontalpodautoscaler-v2beta2-autoscaling","subsections":[]}]},{"section":"-strong-read-operations-horizontalpodautoscaler-v2beta2-autoscaling-strong-","subsections":[{"section":"watch-list-all-namespaces-horizontalpodautoscaler-v2beta2-autoscaling","subsections":[]},{"section":"watch-list-horizontalpodautoscaler-v2beta2-autoscaling","subsections":[]},{"section":"watch-horizontalpodautoscaler-v2beta2-autoscaling","subsections":[]},{"section":"list-all-namespaces-horizontalpodautoscaler-v2beta2-autoscaling","subsections":[]},{"section":"list-horizontalpodautoscaler-v2beta2-autoscaling","subsections":[]},{"section":"read-horizontalpodautoscaler-v2beta2-autoscaling","subsections":[]}]},{"section":"-strong-write-operations-horizontalpodautoscaler-v2beta2-autoscaling-strong-","subsections":[{"section":"delete-collection-horizontalpodautoscaler-v2beta2-autoscaling","subsections":[]},{"section":"delete-horizontalpodautoscaler-v2beta2-autoscaling","subsections":[]},{"section":"replace-horizontalpodautoscaler-v2beta2-autoscaling","subsections":[]},{"section":"patch-horizontalpodautoscaler-v2beta2-autoscaling","subsections":[]},{"section":"create-horizontalpodautoscaler-v2beta2-autoscaling","subsections":[]}]}]},{"section":"httpingressrulevalue-v1beta1-networking-k8s-io","subsections":[]},{"section":"httpingressrulevalue-v1beta1-extensions","subsections":[]},{"section":"httpingresspath-v1beta1-networking-k8s-io","subsections":[]},{"section":"httpingresspath-v1beta1-extensions","subsections":[]},{"section":"forzone-v1beta1-discovery-k8s-io","subsections":[]},{"section":"externalmetricstatus-v2beta1-autoscaling","subsections":[]},{"section":"externalmetricsource-v2beta1-autoscaling","subsections":[]},{"section":"externaldocumentation-v1beta1-apiextensions-k8s-io","subsections":[]},{"section":"eventseries-v1beta1-events-k8s-io","subsections":[]},{"section":"eventseries-v1-events-k8s-io","subsections":[]},{"section":"event-v1beta1-events-k8s-io","subsections":[{"section":"-strong-read-operations-event-v1beta1-events-k8s-io-strong-","subsections":[{"section":"watch-list-all-namespaces-event-v1beta1-events-k8s-io","subsections":[]},{"section":"watch-list-event-v1beta1-events-k8s-io","subsections":[]},{"section":"watch-event-v1beta1-events-k8s-io","subsections":[]},{"section":"list-all-namespaces-event-v1beta1-events-k8s-io","subsections":[]},{"section":"list-event-v1beta1-events-k8s-io","subsections":[]},{"section":"read-event-v1beta1-events-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-event-v1beta1-events-k8s-io-strong-","subsections":[{"section":"delete-collection-event-v1beta1-events-k8s-io","subsections":[]},{"section":"delete-event-v1beta1-events-k8s-io","subsections":[]},{"section":"replace-event-v1beta1-events-k8s-io","subsections":[]},{"section":"patch-event-v1beta1-events-k8s-io","subsections":[]},{"section":"create-event-v1beta1-events-k8s-io","subsections":[]}]}]},{"section":"event-v1-events-k8s-io","subsections":[{"section":"-strong-read-operations-event-v1-events-k8s-io-strong-","subsections":[{"section":"watch-list-all-namespaces-event-v1-events-k8s-io","subsections":[]},{"section":"watch-list-event-v1-events-k8s-io","subsections":[]},{"section":"watch-event-v1-events-k8s-io","subsections":[]},{"section":"list-all-namespaces-event-v1-events-k8s-io","subsections":[]},{"section":"list-event-v1-events-k8s-io","subsections":[]},{"section":"read-event-v1-events-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-event-v1-events-k8s-io-strong-","subsections":[{"section":"delete-collection-event-v1-events-k8s-io","subsections":[]},{"section":"delete-event-v1-events-k8s-io","subsections":[]},{"section":"replace-event-v1-events-k8s-io","subsections":[]},{"section":"patch-event-v1-events-k8s-io","subsections":[]},{"section":"create-event-v1-events-k8s-io","subsections":[]}]}]},{"section":"endpointslice-v1beta1-discovery-k8s-io","subsections":[{"section":"-strong-read-operations-endpointslice-v1beta1-discovery-k8s-io-strong-","subsections":[{"section":"watch-list-all-namespaces-endpointslice-v1beta1-discovery-k8s-io","subsections":[]},{"section":"watch-list-endpointslice-v1beta1-discovery-k8s-io","subsections":[]},{"section":"watch-endpointslice-v1beta1-discovery-k8s-io","subsections":[]},{"section":"list-all-namespaces-endpointslice-v1beta1-discovery-k8s-io","subsections":[]},{"section":"list-endpointslice-v1beta1-discovery-k8s-io","subsections":[]},{"section":"read-endpointslice-v1beta1-discovery-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-endpointslice-v1beta1-discovery-k8s-io-strong-","subsections":[{"section":"delete-collection-endpointslice-v1beta1-discovery-k8s-io","subsections":[]},{"section":"delete-endpointslice-v1beta1-discovery-k8s-io","subsections":[]},{"section":"replace-endpointslice-v1beta1-discovery-k8s-io","subsections":[]},{"section":"patch-endpointslice-v1beta1-discovery-k8s-io","subsections":[]},{"section":"create-endpointslice-v1beta1-discovery-k8s-io","subsections":[]}]}]},{"section":"endpointport-v1beta1-discovery-k8s-io","subsections":[]},{"section":"endpointport-v1-discovery-k8s-io","subsections":[]},{"section":"endpointhints-v1beta1-discovery-k8s-io","subsections":[]},{"section":"endpointconditions-v1beta1-discovery-k8s-io","subsections":[]},{"section":"endpoint-v1beta1-discovery-k8s-io","subsections":[]},{"section":"customresourcevalidation-v1beta1-apiextensions-k8s-io","subsections":[]},{"section":"customresourcesubresources-v1beta1-apiextensions-k8s-io","subsections":[]},{"section":"customresourcesubresourcestatus-v1beta1-apiextensions-k8s-io","subsections":[]},{"section":"customresourcesubresourcescale-v1beta1-apiextensions-k8s-io","subsections":[]},{"section":"customresourcedefinitionversion-v1beta1-apiextensions-k8s-io","subsections":[]},{"section":"customresourcedefinitionnames-v1beta1-apiextensions-k8s-io","subsections":[]},{"section":"customresourcedefinitioncondition-v1beta1-apiextensions-k8s-io","subsections":[]},{"section":"customresourcedefinition-v1beta1-apiextensions-k8s-io","subsections":[{"section":"-strong-status-operations-customresourcedefinition-v1beta1-apiextensions-k8s-io-strong-","subsections":[{"section":"replace-status-customresourcedefinition-v1beta1-apiextensions-k8s-io","subsections":[]},{"section":"read-status-customresourcedefinition-v1beta1-apiextensions-k8s-io","subsections":[]},{"section":"patch-status-customresourcedefinition-v1beta1-apiextensions-k8s-io","subsections":[]}]},{"section":"-strong-read-operations-customresourcedefinition-v1beta1-apiextensions-k8s-io-strong-","subsections":[{"section":"watch-list-customresourcedefinition-v1beta1-apiextensions-k8s-io","subsections":[]},{"section":"watch-customresourcedefinition-v1beta1-apiextensions-k8s-io","subsections":[]},{"section":"list-customresourcedefinition-v1beta1-apiextensions-k8s-io","subsections":[]},{"section":"read-customresourcedefinition-v1beta1-apiextensions-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-customresourcedefinition-v1beta1-apiextensions-k8s-io-strong-","subsections":[{"section":"delete-collection-customresourcedefinition-v1beta1-apiextensions-k8s-io","subsections":[]},{"section":"delete-customresourcedefinition-v1beta1-apiextensions-k8s-io","subsections":[]},{"section":"replace-customresourcedefinition-v1beta1-apiextensions-k8s-io","subsections":[]},{"section":"patch-customresourcedefinition-v1beta1-apiextensions-k8s-io","subsections":[]},{"section":"create-customresourcedefinition-v1beta1-apiextensions-k8s-io","subsections":[]}]}]},{"section":"customresourceconversion-v1beta1-apiextensions-k8s-io","subsections":[]},{"section":"customresourcecolumndefinition-v1beta1-apiextensions-k8s-io","subsections":[]},{"section":"crossversionobjectreference-v2beta1-autoscaling","subsections":[]},{"section":"crossversionobjectreference-v2beta2-autoscaling","subsections":[]},{"section":"cronjob-v1beta1-batch","subsections":[{"section":"-strong-status-operations-cronjob-v1beta1-batch-strong-","subsections":[{"section":"replace-status-cronjob-v1beta1-batch","subsections":[]},{"section":"read-status-cronjob-v1beta1-batch","subsections":[]},{"section":"patch-status-cronjob-v1beta1-batch","subsections":[]}]},{"section":"-strong-read-operations-cronjob-v1beta1-batch-strong-","subsections":[{"section":"watch-list-all-namespaces-cronjob-v1beta1-batch","subsections":[]},{"section":"watch-list-cronjob-v1beta1-batch","subsections":[]},{"section":"watch-cronjob-v1beta1-batch","subsections":[]},{"section":"list-all-namespaces-cronjob-v1beta1-batch","subsections":[]},{"section":"list-cronjob-v1beta1-batch","subsections":[]},{"section":"read-cronjob-v1beta1-batch","subsections":[]}]},{"section":"-strong-write-operations-cronjob-v1beta1-batch-strong-","subsections":[{"section":"delete-collection-cronjob-v1beta1-batch","subsections":[]},{"section":"delete-cronjob-v1beta1-batch","subsections":[]},{"section":"replace-cronjob-v1beta1-batch","subsections":[]},{"section":"patch-cronjob-v1beta1-batch","subsections":[]},{"section":"create-cronjob-v1beta1-batch","subsections":[]}]}]},{"section":"containerresourcemetricstatus-v2beta1-autoscaling","subsections":[]},{"section":"containerresourcemetricsource-v2beta1-autoscaling","subsections":[]},{"section":"clusterrolebinding-v1alpha1-rbac-authorization-k8s-io","subsections":[{"section":"-strong-read-operations-clusterrolebinding-v1alpha1-rbac-authorization-k8s-io-strong-","subsections":[{"section":"watch-list-clusterrolebinding-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"watch-clusterrolebinding-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"list-clusterrolebinding-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"read-clusterrolebinding-v1alpha1-rbac-authorization-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-clusterrolebinding-v1alpha1-rbac-authorization-k8s-io-strong-","subsections":[{"section":"delete-collection-clusterrolebinding-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"delete-clusterrolebinding-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"replace-clusterrolebinding-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"patch-clusterrolebinding-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"create-clusterrolebinding-v1alpha1-rbac-authorization-k8s-io","subsections":[]}]}]},{"section":"clusterrolebinding-v1beta1-rbac-authorization-k8s-io","subsections":[{"section":"-strong-read-operations-clusterrolebinding-v1beta1-rbac-authorization-k8s-io-strong-","subsections":[{"section":"watch-list-clusterrolebinding-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"watch-clusterrolebinding-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"list-clusterrolebinding-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"read-clusterrolebinding-v1beta1-rbac-authorization-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-clusterrolebinding-v1beta1-rbac-authorization-k8s-io-strong-","subsections":[{"section":"delete-collection-clusterrolebinding-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"delete-clusterrolebinding-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"replace-clusterrolebinding-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"patch-clusterrolebinding-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"create-clusterrolebinding-v1beta1-rbac-authorization-k8s-io","subsections":[]}]}]},{"section":"clusterrole-v1alpha1-rbac-authorization-k8s-io","subsections":[{"section":"-strong-read-operations-clusterrole-v1alpha1-rbac-authorization-k8s-io-strong-","subsections":[{"section":"watch-list-clusterrole-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"watch-clusterrole-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"list-clusterrole-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"read-clusterrole-v1alpha1-rbac-authorization-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-clusterrole-v1alpha1-rbac-authorization-k8s-io-strong-","subsections":[{"section":"delete-collection-clusterrole-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"delete-clusterrole-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"replace-clusterrole-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"patch-clusterrole-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"create-clusterrole-v1alpha1-rbac-authorization-k8s-io","subsections":[]}]}]},{"section":"clusterrole-v1beta1-rbac-authorization-k8s-io","subsections":[{"section":"-strong-read-operations-clusterrole-v1beta1-rbac-authorization-k8s-io-strong-","subsections":[{"section":"watch-list-clusterrole-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"watch-clusterrole-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"list-clusterrole-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"read-clusterrole-v1beta1-rbac-authorization-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-clusterrole-v1beta1-rbac-authorization-k8s-io-strong-","subsections":[{"section":"delete-collection-clusterrole-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"delete-clusterrole-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"replace-clusterrole-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"patch-clusterrole-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"create-clusterrole-v1beta1-rbac-authorization-k8s-io","subsections":[]}]}]},{"section":"certificatesigningrequestcondition-v1beta1-certificates-k8s-io","subsections":[]},{"section":"certificatesigningrequest-v1beta1-certificates-k8s-io","subsections":[{"section":"-strong-status-operations-certificatesigningrequest-v1beta1-certificates-k8s-io-strong-","subsections":[{"section":"replace-status-certificatesigningrequest-v1beta1-certificates-k8s-io","subsections":[]},{"section":"read-status-certificatesigningrequest-v1beta1-certificates-k8s-io","subsections":[]},{"section":"patch-status-certificatesigningrequest-v1beta1-certificates-k8s-io","subsections":[]}]},{"section":"-strong-read-operations-certificatesigningrequest-v1beta1-certificates-k8s-io-strong-","subsections":[{"section":"watch-list-certificatesigningrequest-v1beta1-certificates-k8s-io","subsections":[]},{"section":"watch-certificatesigningrequest-v1beta1-certificates-k8s-io","subsections":[]},{"section":"list-certificatesigningrequest-v1beta1-certificates-k8s-io","subsections":[]},{"section":"read-certificatesigningrequest-v1beta1-certificates-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-certificatesigningrequest-v1beta1-certificates-k8s-io-strong-","subsections":[{"section":"delete-collection-certificatesigningrequest-v1beta1-certificates-k8s-io","subsections":[]},{"section":"delete-certificatesigningrequest-v1beta1-certificates-k8s-io","subsections":[]},{"section":"replace-certificatesigningrequest-v1beta1-certificates-k8s-io","subsections":[]},{"section":"patch-certificatesigningrequest-v1beta1-certificates-k8s-io","subsections":[]},{"section":"create-certificatesigningrequest-v1beta1-certificates-k8s-io","subsections":[]}]}]},{"section":"csistoragecapacity-v1alpha1-storage-k8s-io","subsections":[{"section":"-strong-read-operations-csistoragecapacity-v1alpha1-storage-k8s-io-strong-","subsections":[{"section":"watch-list-all-namespaces-csistoragecapacity-v1alpha1-storage-k8s-io","subsections":[]},{"section":"watch-list-csistoragecapacity-v1alpha1-storage-k8s-io","subsections":[]},{"section":"watch-csistoragecapacity-v1alpha1-storage-k8s-io","subsections":[]},{"section":"list-all-namespaces-csistoragecapacity-v1alpha1-storage-k8s-io","subsections":[]},{"section":"list-csistoragecapacity-v1alpha1-storage-k8s-io","subsections":[]},{"section":"read-csistoragecapacity-v1alpha1-storage-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-csistoragecapacity-v1alpha1-storage-k8s-io-strong-","subsections":[{"section":"delete-collection-csistoragecapacity-v1alpha1-storage-k8s-io","subsections":[]},{"section":"delete-csistoragecapacity-v1alpha1-storage-k8s-io","subsections":[]},{"section":"replace-csistoragecapacity-v1alpha1-storage-k8s-io","subsections":[]},{"section":"patch-csistoragecapacity-v1alpha1-storage-k8s-io","subsections":[]},{"section":"create-csistoragecapacity-v1alpha1-storage-k8s-io","subsections":[]}]}]},{"section":"csinodedriver-v1beta1-storage-k8s-io","subsections":[]},{"section":"csinode-v1beta1-storage-k8s-io","subsections":[{"section":"-strong-read-operations-csinode-v1beta1-storage-k8s-io-strong-","subsections":[{"section":"watch-list-csinode-v1beta1-storage-k8s-io","subsections":[]},{"section":"watch-csinode-v1beta1-storage-k8s-io","subsections":[]},{"section":"list-csinode-v1beta1-storage-k8s-io","subsections":[]},{"section":"read-csinode-v1beta1-storage-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-csinode-v1beta1-storage-k8s-io-strong-","subsections":[{"section":"delete-collection-csinode-v1beta1-storage-k8s-io","subsections":[]},{"section":"delete-csinode-v1beta1-storage-k8s-io","subsections":[]},{"section":"replace-csinode-v1beta1-storage-k8s-io","subsections":[]},{"section":"patch-csinode-v1beta1-storage-k8s-io","subsections":[]},{"section":"create-csinode-v1beta1-storage-k8s-io","subsections":[]}]}]},{"section":"csidriver-v1beta1-storage-k8s-io","subsections":[{"section":"-strong-read-operations-csidriver-v1beta1-storage-k8s-io-strong-","subsections":[{"section":"watch-list-csidriver-v1beta1-storage-k8s-io","subsections":[]},{"section":"watch-csidriver-v1beta1-storage-k8s-io","subsections":[]},{"section":"list-csidriver-v1beta1-storage-k8s-io","subsections":[]},{"section":"read-csidriver-v1beta1-storage-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-csidriver-v1beta1-storage-k8s-io-strong-","subsections":[{"section":"delete-collection-csidriver-v1beta1-storage-k8s-io","subsections":[]},{"section":"delete-csidriver-v1beta1-storage-k8s-io","subsections":[]},{"section":"replace-csidriver-v1beta1-storage-k8s-io","subsections":[]},{"section":"patch-csidriver-v1beta1-storage-k8s-io","subsections":[]},{"section":"create-csidriver-v1beta1-storage-k8s-io","subsections":[]}]}]},{"section":"aggregationrule-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"aggregationrule-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"apiservicecondition-v1beta1-apiregistration-k8s-io","subsections":[]},{"section":"apiservice-v1beta1-apiregistration-k8s-io","subsections":[{"section":"-strong-status-operations-apiservice-v1beta1-apiregistration-k8s-io-strong-","subsections":[{"section":"replace-status-apiservice-v1beta1-apiregistration-k8s-io","subsections":[]},{"section":"read-status-apiservice-v1beta1-apiregistration-k8s-io","subsections":[]},{"section":"patch-status-apiservice-v1beta1-apiregistration-k8s-io","subsections":[]}]},{"section":"-strong-read-operations-apiservice-v1beta1-apiregistration-k8s-io-strong-","subsections":[{"section":"watch-list-apiservice-v1beta1-apiregistration-k8s-io","subsections":[]},{"section":"watch-apiservice-v1beta1-apiregistration-k8s-io","subsections":[]},{"section":"list-apiservice-v1beta1-apiregistration-k8s-io","subsections":[]},{"section":"read-apiservice-v1beta1-apiregistration-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-apiservice-v1beta1-apiregistration-k8s-io-strong-","subsections":[{"section":"delete-collection-apiservice-v1beta1-apiregistration-k8s-io","subsections":[]},{"section":"delete-apiservice-v1beta1-apiregistration-k8s-io","subsections":[]},{"section":"replace-apiservice-v1beta1-apiregistration-k8s-io","subsections":[]},{"section":"patch-apiservice-v1beta1-apiregistration-k8s-io","subsections":[]},{"section":"create-apiservice-v1beta1-apiregistration-k8s-io","subsections":[]}]}]},{"section":"-strong-old-api-versions-strong-","subsections":[]},{"section":"windowssecuritycontextoptions-v1-core","subsections":[]},{"section":"weightedpodaffinityterm-v1-core","subsections":[]},{"section":"webhookconversion-v1-apiextensions-k8s-io","subsections":[]},{"section":"webhookclientconfig-v1-admissionregistration-k8s-io","subsections":[]},{"section":"watchevent-v1-meta","subsections":[]},{"section":"vspherevirtualdiskvolumesource-v1-core","subsections":[]},{"section":"volumeprojection-v1-core","subsections":[]},{"section":"volumenoderesources-v1-storage-k8s-io","subsections":[]},{"section":"volumenodeaffinity-v1-core","subsections":[]},{"section":"volumemount-v1-core","subsections":[]},{"section":"volumeerror-v1-storage-k8s-io","subsections":[]},{"section":"volumedevice-v1-core","subsections":[]},{"section":"volumeattachmentsource-v1-storage-k8s-io","subsections":[]},{"section":"validatingwebhook-v1-admissionregistration-k8s-io","subsections":[]},{"section":"usersubject-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"userinfo-v1-authentication-k8s-io","subsections":[]},{"section":"typedlocalobjectreference-v1-core","subsections":[]},{"section":"topologyspreadconstraint-v1-core","subsections":[]},{"section":"topologyselectorterm-v1-core","subsections":[]},{"section":"topologyselectorlabelrequirement-v1-core","subsections":[]},{"section":"toleration-v1-core","subsections":[]},{"section":"time-v1-meta","subsections":[]},{"section":"taint-v1-core","subsections":[]},{"section":"tcpsocketaction-v1-core","subsections":[]},{"section":"sysctl-v1-core","subsections":[]},{"section":"supplementalgroupsstrategyoptions-v1beta1-policy","subsections":[]},{"section":"subjectrulesreviewstatus-v1-authorization-k8s-io","subsections":[]},{"section":"subject-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"storageversioncondition-v1alpha1-internal-apiserver-k8s-io","subsections":[]},{"section":"storageosvolumesource-v1-core","subsections":[]},{"section":"storageospersistentvolumesource-v1-core","subsections":[]},{"section":"statusdetails-v1-meta","subsections":[]},{"section":"statuscause-v1-meta","subsections":[]},{"section":"status-v1-meta","subsections":[]},{"section":"statefulsetupdatestrategy-v1-apps","subsections":[]},{"section":"statefulsetcondition-v1-apps","subsections":[]},{"section":"sessionaffinityconfig-v1-core","subsections":[]},{"section":"servicereference-v1-admissionregistration-k8s-io","subsections":[]},{"section":"serviceport-v1-core","subsections":[]},{"section":"servicebackendport-v1-networking-k8s-io","subsections":[]},{"section":"serviceaccounttokenprojection-v1-core","subsections":[]},{"section":"serviceaccountsubject-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"serverstorageversion-v1alpha1-internal-apiserver-k8s-io","subsections":[]},{"section":"serveraddressbyclientcidr-v1-meta","subsections":[]},{"section":"securitycontext-v1-core","subsections":[]},{"section":"secretvolumesource-v1-core","subsections":[]},{"section":"secretreference-v1-core","subsections":[]},{"section":"secretprojection-v1-core","subsections":[]},{"section":"secretkeyselector-v1-core","subsections":[]},{"section":"secretenvsource-v1-core","subsections":[]},{"section":"seccompprofile-v1-core","subsections":[]},{"section":"scopedresourceselectorrequirement-v1-core","subsections":[]},{"section":"scopeselector-v1-core","subsections":[]},{"section":"scheduling-v1-node-k8s-io","subsections":[]},{"section":"scaleiovolumesource-v1-core","subsections":[]},{"section":"scaleiopersistentvolumesource-v1-core","subsections":[]},{"section":"scale-v1-autoscaling","subsections":[]},{"section":"selinuxstrategyoptions-v1beta1-policy","subsections":[]},{"section":"selinuxoptions-v1-core","subsections":[]},{"section":"runtimeclassstrategyoptions-v1beta1-policy","subsections":[]},{"section":"runasuserstrategyoptions-v1beta1-policy","subsections":[]},{"section":"runasgroupstrategyoptions-v1beta1-policy","subsections":[]},{"section":"rulewithoperations-v1-admissionregistration-k8s-io","subsections":[]},{"section":"rollingupdatestatefulsetstrategy-v1-apps","subsections":[]},{"section":"roleref-v1-rbac-authorization-k8s-io","subsections":[]},{"section":"resourcerule-v1-authorization-k8s-io","subsections":[]},{"section":"resourcerequirements-v1-core","subsections":[]},{"section":"resourcepolicyrule-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"resourcemetricstatus-v2beta2-autoscaling","subsections":[]},{"section":"resourcemetricsource-v2beta2-autoscaling","subsections":[]},{"section":"resourcefieldselector-v1-core","subsections":[]},{"section":"resourceattributes-v1-authorization-k8s-io","subsections":[]},{"section":"replicationcontrollercondition-v1-core","subsections":[]},{"section":"replicasetcondition-v1-apps","subsections":[]},{"section":"rbdvolumesource-v1-core","subsections":[]},{"section":"rbdpersistentvolumesource-v1-core","subsections":[]},{"section":"quobytevolumesource-v1-core","subsections":[]},{"section":"queuingconfiguration-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"quantity-resource-core","subsections":[]},{"section":"projectedvolumesource-v1-core","subsections":[]},{"section":"probe-v1-core","subsections":[]},{"section":"prioritylevelconfigurationreference-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"prioritylevelconfigurationcondition-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"preferredschedulingterm-v1-core","subsections":[]},{"section":"preconditions-v1-meta","subsections":[]},{"section":"portworxvolumesource-v1-core","subsections":[]},{"section":"portstatus-v1-core","subsections":[]},{"section":"policyruleswithsubjects-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"policyrule-v1-rbac-authorization-k8s-io","subsections":[]},{"section":"podsmetricstatus-v2beta2-autoscaling","subsections":[]},{"section":"podsmetricsource-v2beta2-autoscaling","subsections":[]},{"section":"podsecuritycontext-v1-core","subsections":[]},{"section":"podreadinessgate-v1-core","subsections":[]},{"section":"podip-v1-core","subsections":[]},{"section":"poddisruptionbudget-v1-policy","subsections":[]},{"section":"poddnsconfigoption-v1-core","subsections":[]},{"section":"poddnsconfig-v1-core","subsections":[]},{"section":"podcondition-v1-core","subsections":[]},{"section":"podantiaffinity-v1-core","subsections":[]},{"section":"podaffinityterm-v1-core","subsections":[]},{"section":"podaffinity-v1-core","subsections":[]},{"section":"photonpersistentdiskvolumesource-v1-core","subsections":[]},{"section":"persistentvolumeclaimvolumesource-v1-core","subsections":[]},{"section":"persistentvolumeclaimtemplate-v1-core","subsections":[]},{"section":"persistentvolumeclaimcondition-v1-core","subsections":[]},{"section":"patch-v1-meta","subsections":[]},{"section":"ownerreference-v1-meta","subsections":[]},{"section":"overhead-v1-node-k8s-io","subsections":[]},{"section":"objectreference-v1-core","subsections":[]},{"section":"objectmetricstatus-v2beta2-autoscaling","subsections":[]},{"section":"objectmetricsource-v2beta2-autoscaling","subsections":[]},{"section":"objectmeta-v1-meta","subsections":[]},{"section":"objectfieldselector-v1-core","subsections":[]},{"section":"nonresourcerule-v1-authorization-k8s-io","subsections":[]},{"section":"nonresourcepolicyrule-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"nonresourceattributes-v1-authorization-k8s-io","subsections":[]},{"section":"nodesysteminfo-v1-core","subsections":[]},{"section":"nodeselectorterm-v1-core","subsections":[]},{"section":"nodeselectorrequirement-v1-core","subsections":[]},{"section":"nodeselector-v1-core","subsections":[]},{"section":"nodedaemonendpoints-v1-core","subsections":[]},{"section":"nodeconfigstatus-v1-core","subsections":[]},{"section":"nodeconfigsource-v1-core","subsections":[]},{"section":"nodecondition-v1-core","subsections":[]},{"section":"nodeaffinity-v1-core","subsections":[]},{"section":"nodeaddress-v1-core","subsections":[]},{"section":"networkpolicyport-v1-networking-k8s-io","subsections":[]},{"section":"networkpolicypeer-v1-networking-k8s-io","subsections":[]},{"section":"networkpolicyingressrule-v1-networking-k8s-io","subsections":[]},{"section":"networkpolicyegressrule-v1-networking-k8s-io","subsections":[]},{"section":"namespacecondition-v1-core","subsections":[]},{"section":"nfsvolumesource-v1-core","subsections":[]},{"section":"mutatingwebhook-v1-admissionregistration-k8s-io","subsections":[]},{"section":"microtime-v1-meta","subsections":[]},{"section":"metricvaluestatus-v2beta2-autoscaling","subsections":[]},{"section":"metrictarget-v2beta2-autoscaling","subsections":[]},{"section":"metricstatus-v2beta2-autoscaling","subsections":[]},{"section":"metricspec-v2beta2-autoscaling","subsections":[]},{"section":"metricidentifier-v2beta2-autoscaling","subsections":[]},{"section":"managedfieldsentry-v1-meta","subsections":[]},{"section":"localvolumesource-v1-core","subsections":[]},{"section":"localobjectreference-v1-core","subsections":[]},{"section":"loadbalancerstatus-v1-core","subsections":[]},{"section":"loadbalanceringress-v1-core","subsections":[]},{"section":"listmeta-v1-meta","subsections":[]},{"section":"limitedprioritylevelconfiguration-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"limitresponse-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"limitrangeitem-v1-core","subsections":[]},{"section":"lifecycle-v1-core","subsections":[]},{"section":"labelselectorrequirement-v1-meta","subsections":[]},{"section":"labelselector-v1-meta","subsections":[]},{"section":"keytopath-v1-core","subsections":[]},{"section":"jobtemplatespec-v1-batch","subsections":[]},{"section":"jobcondition-v1-batch","subsections":[]},{"section":"jsonschemapropsorbool-v1-apiextensions-k8s-io","subsections":[]},{"section":"jsonschemapropsorarray-v1-apiextensions-k8s-io","subsections":[]},{"section":"jsonschemaprops-v1-apiextensions-k8s-io","subsections":[]},{"section":"json-v1-apiextensions-k8s-io","subsections":[]},{"section":"ingresstls-v1-networking-k8s-io","subsections":[]},{"section":"ingressservicebackend-v1-networking-k8s-io","subsections":[]},{"section":"ingressrule-v1-networking-k8s-io","subsections":[]},{"section":"ingressclassparametersreference-v1-networking-k8s-io","subsections":[]},{"section":"ingressbackend-v1-networking-k8s-io","subsections":[]},{"section":"iscsivolumesource-v1-core","subsections":[]},{"section":"iscsipersistentvolumesource-v1-core","subsections":[]},{"section":"ipblock-v1-networking-k8s-io","subsections":[]},{"section":"idrange-v1beta1-policy","subsections":[]},{"section":"hostportrange-v1beta1-policy","subsections":[]},{"section":"hostpathvolumesource-v1-core","subsections":[]},{"section":"hostalias-v1-core","subsections":[]},{"section":"horizontalpodautoscalercondition-v2beta2-autoscaling","subsections":[]},{"section":"horizontalpodautoscalerbehavior-v2beta2-autoscaling","subsections":[]},{"section":"handler-v1-core","subsections":[]},{"section":"httpingressrulevalue-v1-networking-k8s-io","subsections":[]},{"section":"httpingresspath-v1-networking-k8s-io","subsections":[]},{"section":"httpheader-v1-core","subsections":[]},{"section":"httpgetaction-v1-core","subsections":[]},{"section":"hpascalingrules-v2beta2-autoscaling","subsections":[]},{"section":"hpascalingpolicy-v2beta2-autoscaling","subsections":[]},{"section":"groupversionfordiscovery-v1-meta","subsections":[]},{"section":"groupsubject-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"glusterfsvolumesource-v1-core","subsections":[]},{"section":"glusterfspersistentvolumesource-v1-core","subsections":[]},{"section":"gitrepovolumesource-v1-core","subsections":[]},{"section":"gcepersistentdiskvolumesource-v1-core","subsections":[]},{"section":"forzone-v1-discovery-k8s-io","subsections":[]},{"section":"flowschemacondition-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"flowdistinguishermethod-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"flockervolumesource-v1-core","subsections":[]},{"section":"flexvolumesource-v1-core","subsections":[]},{"section":"flexpersistentvolumesource-v1-core","subsections":[]},{"section":"fieldsv1-v1-meta","subsections":[]},{"section":"fsgroupstrategyoptions-v1beta1-policy","subsections":[]},{"section":"fcvolumesource-v1-core","subsections":[]},{"section":"externalmetricstatus-v2beta2-autoscaling","subsections":[]},{"section":"externalmetricsource-v2beta2-autoscaling","subsections":[]},{"section":"externaldocumentation-v1-apiextensions-k8s-io","subsections":[]},{"section":"execaction-v1-core","subsections":[]},{"section":"eviction-v1beta1-policy","subsections":[]},{"section":"eventsource-v1-core","subsections":[]},{"section":"eventseries-v1-core","subsections":[]},{"section":"ephemeralvolumesource-v1-core","subsections":[]},{"section":"ephemeralcontainers-v1-core","subsections":[]},{"section":"ephemeralcontainer-v1-core","subsections":[]},{"section":"envvarsource-v1-core","subsections":[]},{"section":"envvar-v1-core","subsections":[]},{"section":"envfromsource-v1-core","subsections":[]},{"section":"endpointsubset-v1-core","subsections":[]},{"section":"endpointslice-v1-discovery-k8s-io","subsections":[]},{"section":"endpointport-v1-core","subsections":[]},{"section":"endpointhints-v1-discovery-k8s-io","subsections":[]},{"section":"endpointconditions-v1-discovery-k8s-io","subsections":[]},{"section":"endpointaddress-v1-core","subsections":[]},{"section":"endpoint-v1-discovery-k8s-io","subsections":[]},{"section":"emptydirvolumesource-v1-core","subsections":[]},{"section":"downwardapivolumesource-v1-core","subsections":[]},{"section":"downwardapivolumefile-v1-core","subsections":[]},{"section":"downwardapiprojection-v1-core","subsections":[]},{"section":"deploymentcondition-v1-apps","subsections":[]},{"section":"deleteoptions-v1-meta","subsections":[]},{"section":"daemonsetupdatestrategy-v1-apps","subsections":[]},{"section":"daemonsetcondition-v1-apps","subsections":[]},{"section":"daemonendpoint-v1-core","subsections":[]},{"section":"customresourcevalidation-v1-apiextensions-k8s-io","subsections":[]},{"section":"customresourcesubresources-v1-apiextensions-k8s-io","subsections":[]},{"section":"customresourcesubresourcestatus-v1-apiextensions-k8s-io","subsections":[]},{"section":"customresourcesubresourcescale-v1-apiextensions-k8s-io","subsections":[]},{"section":"customresourcedefinitionversion-v1-apiextensions-k8s-io","subsections":[]},{"section":"customresourcedefinitionnames-v1-apiextensions-k8s-io","subsections":[]},{"section":"customresourcedefinitioncondition-v1-apiextensions-k8s-io","subsections":[]},{"section":"customresourceconversion-v1-apiextensions-k8s-io","subsections":[]},{"section":"customresourcecolumndefinition-v1-apiextensions-k8s-io","subsections":[]},{"section":"crossversionobjectreference-v1-autoscaling","subsections":[]},{"section":"cronjob-v1-batch","subsections":[]},{"section":"containerstatewaiting-v1-core","subsections":[]},{"section":"containerstateterminated-v1-core","subsections":[]},{"section":"containerstaterunning-v1-core","subsections":[]},{"section":"containerstate-v1-core","subsections":[]},{"section":"containerresourcemetricstatus-v2beta2-autoscaling","subsections":[]},{"section":"containerresourcemetricsource-v2beta2-autoscaling","subsections":[]},{"section":"containerport-v1-core","subsections":[]},{"section":"containerimage-v1-core","subsections":[]},{"section":"configmapvolumesource-v1-core","subsections":[]},{"section":"configmapprojection-v1-core","subsections":[]},{"section":"configmapnodeconfigsource-v1-core","subsections":[]},{"section":"configmapkeyselector-v1-core","subsections":[]},{"section":"configmapenvsource-v1-core","subsections":[]},{"section":"condition-v1-meta","subsections":[]},{"section":"componentcondition-v1-core","subsections":[]},{"section":"clientipconfig-v1-core","subsections":[]},{"section":"cindervolumesource-v1-core","subsections":[]},{"section":"cinderpersistentvolumesource-v1-core","subsections":[]},{"section":"certificatesigningrequestcondition-v1-certificates-k8s-io","subsections":[]},{"section":"cephfsvolumesource-v1-core","subsections":[]},{"section":"cephfspersistentvolumesource-v1-core","subsections":[]},{"section":"capabilities-v1-core","subsections":[]},{"section":"csivolumesource-v1-core","subsections":[]},{"section":"csistoragecapacity-v1beta1-storage-k8s-io","subsections":[]},{"section":"csipersistentvolumesource-v1-core","subsections":[]},{"section":"csinodedriver-v1-storage-k8s-io","subsections":[]},{"section":"boundobjectreference-v1-authentication-k8s-io","subsections":[]},{"section":"azurefilevolumesource-v1-core","subsections":[]},{"section":"azurefilepersistentvolumesource-v1-core","subsections":[]},{"section":"azurediskvolumesource-v1-core","subsections":[]},{"section":"attachedvolume-v1-core","subsections":[]},{"section":"allowedhostpath-v1beta1-policy","subsections":[]},{"section":"allowedflexvolume-v1beta1-policy","subsections":[]},{"section":"allowedcsidriver-v1beta1-policy","subsections":[]},{"section":"aggregationrule-v1-rbac-authorization-k8s-io","subsections":[]},{"section":"affinity-v1-core","subsections":[]},{"section":"awselasticblockstorevolumesource-v1-core","subsections":[]},{"section":"apiversions-v1-meta","subsections":[]},{"section":"apiservicecondition-v1-apiregistration-k8s-io","subsections":[]},{"section":"apiresource-v1-meta","subsections":[]},{"section":"apigroup-v1-meta","subsections":[]},{"section":"-strong-definitions-strong-","subsections":[]},{"section":"networkpolicy-v1-networking-k8s-io","subsections":[{"section":"-strong-read-operations-networkpolicy-v1-networking-k8s-io-strong-","subsections":[{"section":"watch-list-all-namespaces-networkpolicy-v1-networking-k8s-io","subsections":[]},{"section":"watch-list-networkpolicy-v1-networking-k8s-io","subsections":[]},{"section":"watch-networkpolicy-v1-networking-k8s-io","subsections":[]},{"section":"list-all-namespaces-networkpolicy-v1-networking-k8s-io","subsections":[]},{"section":"list-networkpolicy-v1-networking-k8s-io","subsections":[]},{"section":"read-networkpolicy-v1-networking-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-networkpolicy-v1-networking-k8s-io-strong-","subsections":[{"section":"delete-collection-networkpolicy-v1-networking-k8s-io","subsections":[]},{"section":"delete-networkpolicy-v1-networking-k8s-io","subsections":[]},{"section":"replace-networkpolicy-v1-networking-k8s-io","subsections":[]},{"section":"patch-networkpolicy-v1-networking-k8s-io","subsections":[]},{"section":"create-networkpolicy-v1-networking-k8s-io","subsections":[]}]}]},{"section":"tokenreview-v1-authentication-k8s-io","subsections":[{"section":"-strong-write-operations-tokenreview-v1-authentication-k8s-io-strong-","subsections":[{"section":"create-tokenreview-v1-authentication-k8s-io","subsections":[]}]}]},{"section":"tokenrequest-v1-authentication-k8s-io","subsections":[]},{"section":"subjectaccessreview-v1-authorization-k8s-io","subsections":[{"section":"-strong-write-operations-subjectaccessreview-v1-authorization-k8s-io-strong-","subsections":[{"section":"create-subjectaccessreview-v1-authorization-k8s-io","subsections":[]}]}]},{"section":"storageversion-v1alpha1-internal-apiserver-k8s-io","subsections":[{"section":"-strong-status-operations-storageversion-v1alpha1-internal-apiserver-k8s-io-strong-","subsections":[{"section":"replace-status-storageversion-v1alpha1-internal-apiserver-k8s-io","subsections":[]},{"section":"read-status-storageversion-v1alpha1-internal-apiserver-k8s-io","subsections":[]},{"section":"patch-status-storageversion-v1alpha1-internal-apiserver-k8s-io","subsections":[]}]},{"section":"-strong-read-operations-storageversion-v1alpha1-internal-apiserver-k8s-io-strong-","subsections":[{"section":"watch-list-storageversion-v1alpha1-internal-apiserver-k8s-io","subsections":[]},{"section":"watch-storageversion-v1alpha1-internal-apiserver-k8s-io","subsections":[]},{"section":"list-storageversion-v1alpha1-internal-apiserver-k8s-io","subsections":[]},{"section":"read-storageversion-v1alpha1-internal-apiserver-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-storageversion-v1alpha1-internal-apiserver-k8s-io-strong-","subsections":[{"section":"delete-collection-storageversion-v1alpha1-internal-apiserver-k8s-io","subsections":[]},{"section":"delete-storageversion-v1alpha1-internal-apiserver-k8s-io","subsections":[]},{"section":"replace-storageversion-v1alpha1-internal-apiserver-k8s-io","subsections":[]},{"section":"patch-storageversion-v1alpha1-internal-apiserver-k8s-io","subsections":[]},{"section":"create-storageversion-v1alpha1-internal-apiserver-k8s-io","subsections":[]}]}]},{"section":"serviceaccount-v1-core","subsections":[{"section":"-strong-read-operations-serviceaccount-v1-core-strong-","subsections":[{"section":"watch-list-all-namespaces-serviceaccount-v1-core","subsections":[]},{"section":"watch-list-serviceaccount-v1-core","subsections":[]},{"section":"watch-serviceaccount-v1-core","subsections":[]},{"section":"list-all-namespaces-serviceaccount-v1-core","subsections":[]},{"section":"list-serviceaccount-v1-core","subsections":[]},{"section":"read-serviceaccount-v1-core","subsections":[]}]},{"section":"-strong-write-operations-serviceaccount-v1-core-strong-","subsections":[{"section":"delete-collection-serviceaccount-v1-core","subsections":[]},{"section":"delete-serviceaccount-v1-core","subsections":[]},{"section":"replace-serviceaccount-v1-core","subsections":[]},{"section":"patch-serviceaccount-v1-core","subsections":[]},{"section":"create-serviceaccount-v1-core","subsections":[]}]}]},{"section":"selfsubjectrulesreview-v1-authorization-k8s-io","subsections":[{"section":"-strong-write-operations-selfsubjectrulesreview-v1-authorization-k8s-io-strong-","subsections":[{"section":"create-selfsubjectrulesreview-v1-authorization-k8s-io","subsections":[]}]}]},{"section":"selfsubjectaccessreview-v1-authorization-k8s-io","subsections":[{"section":"-strong-write-operations-selfsubjectaccessreview-v1-authorization-k8s-io-strong-","subsections":[{"section":"create-selfsubjectaccessreview-v1-authorization-k8s-io","subsections":[]}]}]},{"section":"runtimeclass-v1-node-k8s-io","subsections":[{"section":"-strong-read-operations-runtimeclass-v1-node-k8s-io-strong-","subsections":[{"section":"watch-list-runtimeclass-v1-node-k8s-io","subsections":[]},{"section":"watch-runtimeclass-v1-node-k8s-io","subsections":[]},{"section":"list-runtimeclass-v1-node-k8s-io","subsections":[]},{"section":"read-runtimeclass-v1-node-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-runtimeclass-v1-node-k8s-io-strong-","subsections":[{"section":"delete-collection-runtimeclass-v1-node-k8s-io","subsections":[]},{"section":"delete-runtimeclass-v1-node-k8s-io","subsections":[]},{"section":"replace-runtimeclass-v1-node-k8s-io","subsections":[]},{"section":"patch-runtimeclass-v1-node-k8s-io","subsections":[]},{"section":"create-runtimeclass-v1-node-k8s-io","subsections":[]}]}]},{"section":"rolebinding-v1-rbac-authorization-k8s-io","subsections":[{"section":"-strong-read-operations-rolebinding-v1-rbac-authorization-k8s-io-strong-","subsections":[{"section":"watch-list-all-namespaces-rolebinding-v1-rbac-authorization-k8s-io","subsections":[]},{"section":"watch-list-rolebinding-v1-rbac-authorization-k8s-io","subsections":[]},{"section":"watch-rolebinding-v1-rbac-authorization-k8s-io","subsections":[]},{"section":"list-all-namespaces-rolebinding-v1-rbac-authorization-k8s-io","subsections":[]},{"section":"list-rolebinding-v1-rbac-authorization-k8s-io","subsections":[]},{"section":"read-rolebinding-v1-rbac-authorization-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-rolebinding-v1-rbac-authorization-k8s-io-strong-","subsections":[{"section":"delete-collection-rolebinding-v1-rbac-authorization-k8s-io","subsections":[]},{"section":"delete-rolebinding-v1-rbac-authorization-k8s-io","subsections":[]},{"section":"replace-rolebinding-v1-rbac-authorization-k8s-io","subsections":[]},{"section":"patch-rolebinding-v1-rbac-authorization-k8s-io","subsections":[]},{"section":"create-rolebinding-v1-rbac-authorization-k8s-io","subsections":[]}]}]},{"section":"role-v1-rbac-authorization-k8s-io","subsections":[{"section":"-strong-read-operations-role-v1-rbac-authorization-k8s-io-strong-","subsections":[{"section":"watch-list-all-namespaces-role-v1-rbac-authorization-k8s-io","subsections":[]},{"section":"watch-list-role-v1-rbac-authorization-k8s-io","subsections":[]},{"section":"watch-role-v1-rbac-authorization-k8s-io","subsections":[]},{"section":"list-all-namespaces-role-v1-rbac-authorization-k8s-io","subsections":[]},{"section":"list-role-v1-rbac-authorization-k8s-io","subsections":[]},{"section":"read-role-v1-rbac-authorization-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-role-v1-rbac-authorization-k8s-io-strong-","subsections":[{"section":"delete-collection-role-v1-rbac-authorization-k8s-io","subsections":[]},{"section":"delete-role-v1-rbac-authorization-k8s-io","subsections":[]},{"section":"replace-role-v1-rbac-authorization-k8s-io","subsections":[]},{"section":"patch-role-v1-rbac-authorization-k8s-io","subsections":[]},{"section":"create-role-v1-rbac-authorization-k8s-io","subsections":[]}]}]},{"section":"resourcequota-v1-core","subsections":[{"section":"-strong-status-operations-resourcequota-v1-core-strong-","subsections":[{"section":"replace-status-resourcequota-v1-core","subsections":[]},{"section":"read-status-resourcequota-v1-core","subsections":[]},{"section":"patch-status-resourcequota-v1-core","subsections":[]}]},{"section":"-strong-read-operations-resourcequota-v1-core-strong-","subsections":[{"section":"watch-list-all-namespaces-resourcequota-v1-core","subsections":[]},{"section":"watch-list-resourcequota-v1-core","subsections":[]},{"section":"watch-resourcequota-v1-core","subsections":[]},{"section":"list-all-namespaces-resourcequota-v1-core","subsections":[]},{"section":"list-resourcequota-v1-core","subsections":[]},{"section":"read-resourcequota-v1-core","subsections":[]}]},{"section":"-strong-write-operations-resourcequota-v1-core-strong-","subsections":[{"section":"delete-collection-resourcequota-v1-core","subsections":[]},{"section":"delete-resourcequota-v1-core","subsections":[]},{"section":"replace-resourcequota-v1-core","subsections":[]},{"section":"patch-resourcequota-v1-core","subsections":[]},{"section":"create-resourcequota-v1-core","subsections":[]}]}]},{"section":"prioritylevelconfiguration-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[{"section":"-strong-status-operations-prioritylevelconfiguration-v1beta1-flowcontrol-apiserver-k8s-io-strong-","subsections":[{"section":"replace-status-prioritylevelconfiguration-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"read-status-prioritylevelconfiguration-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"patch-status-prioritylevelconfiguration-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]}]},{"section":"-strong-read-operations-prioritylevelconfiguration-v1beta1-flowcontrol-apiserver-k8s-io-strong-","subsections":[{"section":"watch-list-prioritylevelconfiguration-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"watch-prioritylevelconfiguration-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"list-prioritylevelconfiguration-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"read-prioritylevelconfiguration-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-prioritylevelconfiguration-v1beta1-flowcontrol-apiserver-k8s-io-strong-","subsections":[{"section":"delete-collection-prioritylevelconfiguration-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"delete-prioritylevelconfiguration-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"replace-prioritylevelconfiguration-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"patch-prioritylevelconfiguration-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"create-prioritylevelconfiguration-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]}]}]},{"section":"persistentvolume-v1-core","subsections":[{"section":"-strong-status-operations-persistentvolume-v1-core-strong-","subsections":[{"section":"replace-status-persistentvolume-v1-core","subsections":[]},{"section":"read-status-persistentvolume-v1-core","subsections":[]},{"section":"patch-status-persistentvolume-v1-core","subsections":[]}]},{"section":"-strong-read-operations-persistentvolume-v1-core-strong-","subsections":[{"section":"watch-list-persistentvolume-v1-core","subsections":[]},{"section":"watch-persistentvolume-v1-core","subsections":[]},{"section":"list-persistentvolume-v1-core","subsections":[]},{"section":"read-persistentvolume-v1-core","subsections":[]}]},{"section":"-strong-write-operations-persistentvolume-v1-core-strong-","subsections":[{"section":"delete-collection-persistentvolume-v1-core","subsections":[]},{"section":"delete-persistentvolume-v1-core","subsections":[]},{"section":"replace-persistentvolume-v1-core","subsections":[]},{"section":"patch-persistentvolume-v1-core","subsections":[]},{"section":"create-persistentvolume-v1-core","subsections":[]}]}]},{"section":"node-v1-core","subsections":[{"section":"-strong-proxy-operations-node-v1-core-strong-","subsections":[{"section":"replace-connect-proxy-path-node-v1-core","subsections":[]},{"section":"replace-connect-proxy-node-v1-core","subsections":[]},{"section":"head-connect-proxy-path-node-v1-core","subsections":[]},{"section":"head-connect-proxy-node-v1-core","subsections":[]},{"section":"get-connect-proxy-path-node-v1-core","subsections":[]},{"section":"get-connect-proxy-node-v1-core","subsections":[]},{"section":"delete-connect-proxy-path-node-v1-core","subsections":[]},{"section":"delete-connect-proxy-node-v1-core","subsections":[]},{"section":"create-connect-proxy-path-node-v1-core","subsections":[]},{"section":"create-connect-proxy-node-v1-core","subsections":[]}]},{"section":"-strong-status-operations-node-v1-core-strong-","subsections":[{"section":"replace-status-node-v1-core","subsections":[]},{"section":"read-status-node-v1-core","subsections":[]},{"section":"patch-status-node-v1-core","subsections":[]}]},{"section":"-strong-read-operations-node-v1-core-strong-","subsections":[{"section":"watch-list-node-v1-core","subsections":[]},{"section":"watch-node-v1-core","subsections":[]},{"section":"list-node-v1-core","subsections":[]},{"section":"read-node-v1-core","subsections":[]}]},{"section":"-strong-write-operations-node-v1-core-strong-","subsections":[{"section":"delete-collection-node-v1-core","subsections":[]},{"section":"delete-node-v1-core","subsections":[]},{"section":"replace-node-v1-core","subsections":[]},{"section":"patch-node-v1-core","subsections":[]},{"section":"create-node-v1-core","subsections":[]}]}]},{"section":"namespace-v1-core","subsections":[{"section":"-strong-status-operations-namespace-v1-core-strong-","subsections":[{"section":"replace-status-namespace-v1-core","subsections":[]},{"section":"read-status-namespace-v1-core","subsections":[]},{"section":"patch-status-namespace-v1-core","subsections":[]}]},{"section":"-strong-read-operations-namespace-v1-core-strong-","subsections":[{"section":"watch-list-namespace-v1-core","subsections":[]},{"section":"watch-namespace-v1-core","subsections":[]},{"section":"list-namespace-v1-core","subsections":[]},{"section":"read-namespace-v1-core","subsections":[]}]},{"section":"-strong-write-operations-namespace-v1-core-strong-","subsections":[{"section":"delete-namespace-v1-core","subsections":[]},{"section":"replace-namespace-v1-core","subsections":[]},{"section":"patch-namespace-v1-core","subsections":[]},{"section":"create-namespace-v1-core","subsections":[]}]}]},{"section":"localsubjectaccessreview-v1-authorization-k8s-io","subsections":[{"section":"-strong-write-operations-localsubjectaccessreview-v1-authorization-k8s-io-strong-","subsections":[{"section":"create-localsubjectaccessreview-v1-authorization-k8s-io","subsections":[]}]}]},{"section":"lease-v1-coordination-k8s-io","subsections":[{"section":"-strong-read-operations-lease-v1-coordination-k8s-io-strong-","subsections":[{"section":"watch-list-all-namespaces-lease-v1-coordination-k8s-io","subsections":[]},{"section":"watch-list-lease-v1-coordination-k8s-io","subsections":[]},{"section":"watch-lease-v1-coordination-k8s-io","subsections":[]},{"section":"list-all-namespaces-lease-v1-coordination-k8s-io","subsections":[]},{"section":"list-lease-v1-coordination-k8s-io","subsections":[]},{"section":"read-lease-v1-coordination-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-lease-v1-coordination-k8s-io-strong-","subsections":[{"section":"delete-collection-lease-v1-coordination-k8s-io","subsections":[]},{"section":"delete-lease-v1-coordination-k8s-io","subsections":[]},{"section":"replace-lease-v1-coordination-k8s-io","subsections":[]},{"section":"patch-lease-v1-coordination-k8s-io","subsections":[]},{"section":"create-lease-v1-coordination-k8s-io","subsections":[]}]}]},{"section":"flowschema-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[{"section":"-strong-status-operations-flowschema-v1beta1-flowcontrol-apiserver-k8s-io-strong-","subsections":[{"section":"replace-status-flowschema-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"read-status-flowschema-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"patch-status-flowschema-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]}]},{"section":"-strong-read-operations-flowschema-v1beta1-flowcontrol-apiserver-k8s-io-strong-","subsections":[{"section":"watch-list-flowschema-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"watch-flowschema-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"list-flowschema-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"read-flowschema-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-flowschema-v1beta1-flowcontrol-apiserver-k8s-io-strong-","subsections":[{"section":"delete-collection-flowschema-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"delete-flowschema-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"replace-flowschema-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"patch-flowschema-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"create-flowschema-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]}]}]},{"section":"componentstatus-v1-core","subsections":[{"section":"-strong-read-operations-componentstatus-v1-core-strong-","subsections":[{"section":"list-componentstatus-v1-core","subsections":[]},{"section":"read-componentstatus-v1-core","subsections":[]}]}]},{"section":"clusterrolebinding-v1-rbac-authorization-k8s-io","subsections":[{"section":"-strong-read-operations-clusterrolebinding-v1-rbac-authorization-k8s-io-strong-","subsections":[{"section":"watch-list-clusterrolebinding-v1-rbac-authorization-k8s-io","subsections":[]},{"section":"watch-clusterrolebinding-v1-rbac-authorization-k8s-io","subsections":[]},{"section":"list-clusterrolebinding-v1-rbac-authorization-k8s-io","subsections":[]},{"section":"read-clusterrolebinding-v1-rbac-authorization-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-clusterrolebinding-v1-rbac-authorization-k8s-io-strong-","subsections":[{"section":"delete-collection-clusterrolebinding-v1-rbac-authorization-k8s-io","subsections":[]},{"section":"delete-clusterrolebinding-v1-rbac-authorization-k8s-io","subsections":[]},{"section":"replace-clusterrolebinding-v1-rbac-authorization-k8s-io","subsections":[]},{"section":"patch-clusterrolebinding-v1-rbac-authorization-k8s-io","subsections":[]},{"section":"create-clusterrolebinding-v1-rbac-authorization-k8s-io","subsections":[]}]}]},{"section":"clusterrole-v1-rbac-authorization-k8s-io","subsections":[{"section":"-strong-read-operations-clusterrole-v1-rbac-authorization-k8s-io-strong-","subsections":[{"section":"watch-list-clusterrole-v1-rbac-authorization-k8s-io","subsections":[]},{"section":"watch-clusterrole-v1-rbac-authorization-k8s-io","subsections":[]},{"section":"list-clusterrole-v1-rbac-authorization-k8s-io","subsections":[]},{"section":"read-clusterrole-v1-rbac-authorization-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-clusterrole-v1-rbac-authorization-k8s-io-strong-","subsections":[{"section":"delete-collection-clusterrole-v1-rbac-authorization-k8s-io","subsections":[]},{"section":"delete-clusterrole-v1-rbac-authorization-k8s-io","subsections":[]},{"section":"replace-clusterrole-v1-rbac-authorization-k8s-io","subsections":[]},{"section":"patch-clusterrole-v1-rbac-authorization-k8s-io","subsections":[]},{"section":"create-clusterrole-v1-rbac-authorization-k8s-io","subsections":[]}]}]},{"section":"certificatesigningrequest-v1-certificates-k8s-io","subsections":[{"section":"-strong-status-operations-certificatesigningrequest-v1-certificates-k8s-io-strong-","subsections":[{"section":"replace-status-certificatesigningrequest-v1-certificates-k8s-io","subsections":[]},{"section":"read-status-certificatesigningrequest-v1-certificates-k8s-io","subsections":[]},{"section":"patch-status-certificatesigningrequest-v1-certificates-k8s-io","subsections":[]}]},{"section":"-strong-read-operations-certificatesigningrequest-v1-certificates-k8s-io-strong-","subsections":[{"section":"watch-list-certificatesigningrequest-v1-certificates-k8s-io","subsections":[]},{"section":"watch-certificatesigningrequest-v1-certificates-k8s-io","subsections":[]},{"section":"list-certificatesigningrequest-v1-certificates-k8s-io","subsections":[]},{"section":"read-certificatesigningrequest-v1-certificates-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-certificatesigningrequest-v1-certificates-k8s-io-strong-","subsections":[{"section":"delete-collection-certificatesigningrequest-v1-certificates-k8s-io","subsections":[]},{"section":"delete-certificatesigningrequest-v1-certificates-k8s-io","subsections":[]},{"section":"replace-certificatesigningrequest-v1-certificates-k8s-io","subsections":[]},{"section":"patch-certificatesigningrequest-v1-certificates-k8s-io","subsections":[]},{"section":"create-certificatesigningrequest-v1-certificates-k8s-io","subsections":[]}]}]},{"section":"binding-v1-core","subsections":[{"section":"-strong-write-operations-binding-v1-core-strong-","subsections":[{"section":"create-binding-v1-core","subsections":[]}]}]},{"section":"apiservice-v1-apiregistration-k8s-io","subsections":[{"section":"-strong-status-operations-apiservice-v1-apiregistration-k8s-io-strong-","subsections":[{"section":"replace-status-apiservice-v1-apiregistration-k8s-io","subsections":[]},{"section":"read-status-apiservice-v1-apiregistration-k8s-io","subsections":[]},{"section":"patch-status-apiservice-v1-apiregistration-k8s-io","subsections":[]}]},{"section":"-strong-read-operations-apiservice-v1-apiregistration-k8s-io-strong-","subsections":[{"section":"watch-list-apiservice-v1-apiregistration-k8s-io","subsections":[]},{"section":"watch-apiservice-v1-apiregistration-k8s-io","subsections":[]},{"section":"list-apiservice-v1-apiregistration-k8s-io","subsections":[]},{"section":"read-apiservice-v1-apiregistration-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-apiservice-v1-apiregistration-k8s-io-strong-","subsections":[{"section":"delete-collection-apiservice-v1-apiregistration-k8s-io","subsections":[]},{"section":"delete-apiservice-v1-apiregistration-k8s-io","subsections":[]},{"section":"replace-apiservice-v1-apiregistration-k8s-io","subsections":[]},{"section":"patch-apiservice-v1-apiregistration-k8s-io","subsections":[]},{"section":"create-apiservice-v1-apiregistration-k8s-io","subsections":[]}]}]},{"section":"-strong-cluster-apis-strong-","subsections":[]},{"section":"podsecuritypolicy-v1beta1-policy","subsections":[{"section":"-strong-read-operations-podsecuritypolicy-v1beta1-policy-strong-","subsections":[{"section":"watch-list-podsecuritypolicy-v1beta1-policy","subsections":[]},{"section":"watch-podsecuritypolicy-v1beta1-policy","subsections":[]},{"section":"list-podsecuritypolicy-v1beta1-policy","subsections":[]},{"section":"read-podsecuritypolicy-v1beta1-policy","subsections":[]}]},{"section":"-strong-write-operations-podsecuritypolicy-v1beta1-policy-strong-","subsections":[{"section":"delete-collection-podsecuritypolicy-v1beta1-policy","subsections":[]},{"section":"delete-podsecuritypolicy-v1beta1-policy","subsections":[]},{"section":"replace-podsecuritypolicy-v1beta1-policy","subsections":[]},{"section":"patch-podsecuritypolicy-v1beta1-policy","subsections":[]},{"section":"create-podsecuritypolicy-v1beta1-policy","subsections":[]}]}]},{"section":"priorityclass-v1-scheduling-k8s-io","subsections":[{"section":"-strong-read-operations-priorityclass-v1-scheduling-k8s-io-strong-","subsections":[{"section":"watch-list-priorityclass-v1-scheduling-k8s-io","subsections":[]},{"section":"watch-priorityclass-v1-scheduling-k8s-io","subsections":[]},{"section":"list-priorityclass-v1-scheduling-k8s-io","subsections":[]},{"section":"read-priorityclass-v1-scheduling-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-priorityclass-v1-scheduling-k8s-io-strong-","subsections":[{"section":"delete-collection-priorityclass-v1-scheduling-k8s-io","subsections":[]},{"section":"delete-priorityclass-v1-scheduling-k8s-io","subsections":[]},{"section":"replace-priorityclass-v1-scheduling-k8s-io","subsections":[]},{"section":"patch-priorityclass-v1-scheduling-k8s-io","subsections":[]},{"section":"create-priorityclass-v1-scheduling-k8s-io","subsections":[]}]}]},{"section":"poddisruptionbudget-v1beta1-policy","subsections":[{"section":"-strong-status-operations-poddisruptionbudget-v1beta1-policy-strong-","subsections":[{"section":"replace-status-poddisruptionbudget-v1beta1-policy","subsections":[]},{"section":"read-status-poddisruptionbudget-v1beta1-policy","subsections":[]},{"section":"patch-status-poddisruptionbudget-v1beta1-policy","subsections":[]}]},{"section":"-strong-read-operations-poddisruptionbudget-v1beta1-policy-strong-","subsections":[{"section":"watch-list-all-namespaces-poddisruptionbudget-v1beta1-policy","subsections":[]},{"section":"watch-list-poddisruptionbudget-v1beta1-policy","subsections":[]},{"section":"watch-poddisruptionbudget-v1beta1-policy","subsections":[]},{"section":"list-all-namespaces-poddisruptionbudget-v1beta1-policy","subsections":[]},{"section":"list-poddisruptionbudget-v1beta1-policy","subsections":[]},{"section":"read-poddisruptionbudget-v1beta1-policy","subsections":[]}]},{"section":"-strong-write-operations-poddisruptionbudget-v1beta1-policy-strong-","subsections":[{"section":"delete-collection-poddisruptionbudget-v1beta1-policy","subsections":[]},{"section":"delete-poddisruptionbudget-v1beta1-policy","subsections":[]},{"section":"replace-poddisruptionbudget-v1beta1-policy","subsections":[]},{"section":"patch-poddisruptionbudget-v1beta1-policy","subsections":[]},{"section":"create-poddisruptionbudget-v1beta1-policy","subsections":[]}]}]},{"section":"podtemplate-v1-core","subsections":[{"section":"-strong-read-operations-podtemplate-v1-core-strong-","subsections":[{"section":"watch-list-all-namespaces-podtemplate-v1-core","subsections":[]},{"section":"watch-list-podtemplate-v1-core","subsections":[]},{"section":"watch-podtemplate-v1-core","subsections":[]},{"section":"list-all-namespaces-podtemplate-v1-core","subsections":[]},{"section":"list-podtemplate-v1-core","subsections":[]},{"section":"read-podtemplate-v1-core","subsections":[]}]},{"section":"-strong-write-operations-podtemplate-v1-core-strong-","subsections":[{"section":"delete-collection-podtemplate-v1-core","subsections":[]},{"section":"delete-podtemplate-v1-core","subsections":[]},{"section":"replace-podtemplate-v1-core","subsections":[]},{"section":"patch-podtemplate-v1-core","subsections":[]},{"section":"create-podtemplate-v1-core","subsections":[]}]}]},{"section":"validatingwebhookconfiguration-v1-admissionregistration-k8s-io","subsections":[{"section":"-strong-read-operations-validatingwebhookconfiguration-v1-admissionregistration-k8s-io-strong-","subsections":[{"section":"watch-list-validatingwebhookconfiguration-v1-admissionregistration-k8s-io","subsections":[]},{"section":"watch-validatingwebhookconfiguration-v1-admissionregistration-k8s-io","subsections":[]},{"section":"list-validatingwebhookconfiguration-v1-admissionregistration-k8s-io","subsections":[]},{"section":"read-validatingwebhookconfiguration-v1-admissionregistration-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-validatingwebhookconfiguration-v1-admissionregistration-k8s-io-strong-","subsections":[{"section":"delete-collection-validatingwebhookconfiguration-v1-admissionregistration-k8s-io","subsections":[]},{"section":"delete-validatingwebhookconfiguration-v1-admissionregistration-k8s-io","subsections":[]},{"section":"replace-validatingwebhookconfiguration-v1-admissionregistration-k8s-io","subsections":[]},{"section":"patch-validatingwebhookconfiguration-v1-admissionregistration-k8s-io","subsections":[]},{"section":"create-validatingwebhookconfiguration-v1-admissionregistration-k8s-io","subsections":[]}]}]},{"section":"mutatingwebhookconfiguration-v1-admissionregistration-k8s-io","subsections":[{"section":"-strong-read-operations-mutatingwebhookconfiguration-v1-admissionregistration-k8s-io-strong-","subsections":[{"section":"watch-list-mutatingwebhookconfiguration-v1-admissionregistration-k8s-io","subsections":[]},{"section":"watch-mutatingwebhookconfiguration-v1-admissionregistration-k8s-io","subsections":[]},{"section":"list-mutatingwebhookconfiguration-v1-admissionregistration-k8s-io","subsections":[]},{"section":"read-mutatingwebhookconfiguration-v1-admissionregistration-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-mutatingwebhookconfiguration-v1-admissionregistration-k8s-io-strong-","subsections":[{"section":"delete-collection-mutatingwebhookconfiguration-v1-admissionregistration-k8s-io","subsections":[]},{"section":"delete-mutatingwebhookconfiguration-v1-admissionregistration-k8s-io","subsections":[]},{"section":"replace-mutatingwebhookconfiguration-v1-admissionregistration-k8s-io","subsections":[]},{"section":"patch-mutatingwebhookconfiguration-v1-admissionregistration-k8s-io","subsections":[]},{"section":"create-mutatingwebhookconfiguration-v1-admissionregistration-k8s-io","subsections":[]}]}]},{"section":"horizontalpodautoscaler-v1-autoscaling","subsections":[{"section":"-strong-status-operations-horizontalpodautoscaler-v1-autoscaling-strong-","subsections":[{"section":"replace-status-horizontalpodautoscaler-v1-autoscaling","subsections":[]},{"section":"read-status-horizontalpodautoscaler-v1-autoscaling","subsections":[]},{"section":"patch-status-horizontalpodautoscaler-v1-autoscaling","subsections":[]}]},{"section":"-strong-read-operations-horizontalpodautoscaler-v1-autoscaling-strong-","subsections":[{"section":"watch-list-all-namespaces-horizontalpodautoscaler-v1-autoscaling","subsections":[]},{"section":"watch-list-horizontalpodautoscaler-v1-autoscaling","subsections":[]},{"section":"watch-horizontalpodautoscaler-v1-autoscaling","subsections":[]},{"section":"list-all-namespaces-horizontalpodautoscaler-v1-autoscaling","subsections":[]},{"section":"list-horizontalpodautoscaler-v1-autoscaling","subsections":[]},{"section":"read-horizontalpodautoscaler-v1-autoscaling","subsections":[]}]},{"section":"-strong-write-operations-horizontalpodautoscaler-v1-autoscaling-strong-","subsections":[{"section":"delete-collection-horizontalpodautoscaler-v1-autoscaling","subsections":[]},{"section":"delete-horizontalpodautoscaler-v1-autoscaling","subsections":[]},{"section":"replace-horizontalpodautoscaler-v1-autoscaling","subsections":[]},{"section":"patch-horizontalpodautoscaler-v1-autoscaling","subsections":[]},{"section":"create-horizontalpodautoscaler-v1-autoscaling","subsections":[]}]}]},{"section":"limitrange-v1-core","subsections":[{"section":"-strong-read-operations-limitrange-v1-core-strong-","subsections":[{"section":"watch-list-all-namespaces-limitrange-v1-core","subsections":[]},{"section":"watch-list-limitrange-v1-core","subsections":[]},{"section":"watch-limitrange-v1-core","subsections":[]},{"section":"list-all-namespaces-limitrange-v1-core","subsections":[]},{"section":"list-limitrange-v1-core","subsections":[]},{"section":"read-limitrange-v1-core","subsections":[]}]},{"section":"-strong-write-operations-limitrange-v1-core-strong-","subsections":[{"section":"delete-collection-limitrange-v1-core","subsections":[]},{"section":"delete-limitrange-v1-core","subsections":[]},{"section":"replace-limitrange-v1-core","subsections":[]},{"section":"patch-limitrange-v1-core","subsections":[]},{"section":"create-limitrange-v1-core","subsections":[]}]}]},{"section":"event-v1-core","subsections":[{"section":"-strong-read-operations-event-v1-core-strong-","subsections":[{"section":"watch-list-all-namespaces-event-v1-core","subsections":[]},{"section":"watch-list-event-v1-core","subsections":[]},{"section":"watch-event-v1-core","subsections":[]},{"section":"list-all-namespaces-event-v1-core","subsections":[]},{"section":"list-event-v1-core","subsections":[]},{"section":"read-event-v1-core","subsections":[]}]},{"section":"-strong-write-operations-event-v1-core-strong-","subsections":[{"section":"delete-collection-event-v1-core","subsections":[]},{"section":"delete-event-v1-core","subsections":[]},{"section":"replace-event-v1-core","subsections":[]},{"section":"patch-event-v1-core","subsections":[]},{"section":"create-event-v1-core","subsections":[]}]}]},{"section":"customresourcedefinition-v1-apiextensions-k8s-io","subsections":[{"section":"-strong-status-operations-customresourcedefinition-v1-apiextensions-k8s-io-strong-","subsections":[{"section":"replace-status-customresourcedefinition-v1-apiextensions-k8s-io","subsections":[]},{"section":"read-status-customresourcedefinition-v1-apiextensions-k8s-io","subsections":[]},{"section":"patch-status-customresourcedefinition-v1-apiextensions-k8s-io","subsections":[]}]},{"section":"-strong-read-operations-customresourcedefinition-v1-apiextensions-k8s-io-strong-","subsections":[{"section":"watch-list-customresourcedefinition-v1-apiextensions-k8s-io","subsections":[]},{"section":"watch-customresourcedefinition-v1-apiextensions-k8s-io","subsections":[]},{"section":"list-customresourcedefinition-v1-apiextensions-k8s-io","subsections":[]},{"section":"read-customresourcedefinition-v1-apiextensions-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-customresourcedefinition-v1-apiextensions-k8s-io-strong-","subsections":[{"section":"delete-collection-customresourcedefinition-v1-apiextensions-k8s-io","subsections":[]},{"section":"delete-customresourcedefinition-v1-apiextensions-k8s-io","subsections":[]},{"section":"replace-customresourcedefinition-v1-apiextensions-k8s-io","subsections":[]},{"section":"patch-customresourcedefinition-v1-apiextensions-k8s-io","subsections":[]},{"section":"create-customresourcedefinition-v1-apiextensions-k8s-io","subsections":[]}]}]},{"section":"controllerrevision-v1-apps","subsections":[{"section":"-strong-read-operations-controllerrevision-v1-apps-strong-","subsections":[{"section":"watch-list-all-namespaces-controllerrevision-v1-apps","subsections":[]},{"section":"watch-list-controllerrevision-v1-apps","subsections":[]},{"section":"watch-controllerrevision-v1-apps","subsections":[]},{"section":"list-all-namespaces-controllerrevision-v1-apps","subsections":[]},{"section":"list-controllerrevision-v1-apps","subsections":[]},{"section":"read-controllerrevision-v1-apps","subsections":[]}]},{"section":"-strong-write-operations-controllerrevision-v1-apps-strong-","subsections":[{"section":"delete-collection-controllerrevision-v1-apps","subsections":[]},{"section":"delete-controllerrevision-v1-apps","subsections":[]},{"section":"replace-controllerrevision-v1-apps","subsections":[]},{"section":"patch-controllerrevision-v1-apps","subsections":[]},{"section":"create-controllerrevision-v1-apps","subsections":[]}]}]},{"section":"-strong-metadata-apis-strong-","subsections":[]},{"section":"volumeattachment-v1-storage-k8s-io","subsections":[{"section":"-strong-status-operations-volumeattachment-v1-storage-k8s-io-strong-","subsections":[{"section":"replace-status-volumeattachment-v1-storage-k8s-io","subsections":[]},{"section":"read-status-volumeattachment-v1-storage-k8s-io","subsections":[]},{"section":"patch-status-volumeattachment-v1-storage-k8s-io","subsections":[]}]},{"section":"-strong-read-operations-volumeattachment-v1-storage-k8s-io-strong-","subsections":[{"section":"watch-list-volumeattachment-v1-storage-k8s-io","subsections":[]},{"section":"watch-volumeattachment-v1-storage-k8s-io","subsections":[]},{"section":"list-volumeattachment-v1-storage-k8s-io","subsections":[]},{"section":"read-volumeattachment-v1-storage-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-volumeattachment-v1-storage-k8s-io-strong-","subsections":[{"section":"delete-collection-volumeattachment-v1-storage-k8s-io","subsections":[]},{"section":"delete-volumeattachment-v1-storage-k8s-io","subsections":[]},{"section":"replace-volumeattachment-v1-storage-k8s-io","subsections":[]},{"section":"patch-volumeattachment-v1-storage-k8s-io","subsections":[]},{"section":"create-volumeattachment-v1-storage-k8s-io","subsections":[]}]}]},{"section":"volume-v1-core","subsections":[]},{"section":"storageclass-v1-storage-k8s-io","subsections":[{"section":"-strong-read-operations-storageclass-v1-storage-k8s-io-strong-","subsections":[{"section":"watch-list-storageclass-v1-storage-k8s-io","subsections":[]},{"section":"watch-storageclass-v1-storage-k8s-io","subsections":[]},{"section":"list-storageclass-v1-storage-k8s-io","subsections":[]},{"section":"read-storageclass-v1-storage-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-storageclass-v1-storage-k8s-io-strong-","subsections":[{"section":"delete-collection-storageclass-v1-storage-k8s-io","subsections":[]},{"section":"delete-storageclass-v1-storage-k8s-io","subsections":[]},{"section":"replace-storageclass-v1-storage-k8s-io","subsections":[]},{"section":"patch-storageclass-v1-storage-k8s-io","subsections":[]},{"section":"create-storageclass-v1-storage-k8s-io","subsections":[]}]}]},{"section":"persistentvolumeclaim-v1-core","subsections":[{"section":"-strong-status-operations-persistentvolumeclaim-v1-core-strong-","subsections":[{"section":"replace-status-persistentvolumeclaim-v1-core","subsections":[]},{"section":"read-status-persistentvolumeclaim-v1-core","subsections":[]},{"section":"patch-status-persistentvolumeclaim-v1-core","subsections":[]}]},{"section":"-strong-read-operations-persistentvolumeclaim-v1-core-strong-","subsections":[{"section":"watch-list-all-namespaces-persistentvolumeclaim-v1-core","subsections":[]},{"section":"watch-list-persistentvolumeclaim-v1-core","subsections":[]},{"section":"watch-persistentvolumeclaim-v1-core","subsections":[]},{"section":"list-all-namespaces-persistentvolumeclaim-v1-core","subsections":[]},{"section":"list-persistentvolumeclaim-v1-core","subsections":[]},{"section":"read-persistentvolumeclaim-v1-core","subsections":[]}]},{"section":"-strong-write-operations-persistentvolumeclaim-v1-core-strong-","subsections":[{"section":"delete-collection-persistentvolumeclaim-v1-core","subsections":[]},{"section":"delete-persistentvolumeclaim-v1-core","subsections":[]},{"section":"replace-persistentvolumeclaim-v1-core","subsections":[]},{"section":"patch-persistentvolumeclaim-v1-core","subsections":[]},{"section":"create-persistentvolumeclaim-v1-core","subsections":[]}]}]},{"section":"secret-v1-core","subsections":[{"section":"-strong-read-operations-secret-v1-core-strong-","subsections":[{"section":"watch-list-all-namespaces-secret-v1-core","subsections":[]},{"section":"watch-list-secret-v1-core","subsections":[]},{"section":"watch-secret-v1-core","subsections":[]},{"section":"list-all-namespaces-secret-v1-core","subsections":[]},{"section":"list-secret-v1-core","subsections":[]},{"section":"read-secret-v1-core","subsections":[]}]},{"section":"-strong-write-operations-secret-v1-core-strong-","subsections":[{"section":"delete-collection-secret-v1-core","subsections":[]},{"section":"delete-secret-v1-core","subsections":[]},{"section":"replace-secret-v1-core","subsections":[]},{"section":"patch-secret-v1-core","subsections":[]},{"section":"create-secret-v1-core","subsections":[]}]}]},{"section":"csinode-v1-storage-k8s-io","subsections":[{"section":"-strong-read-operations-csinode-v1-storage-k8s-io-strong-","subsections":[{"section":"watch-list-csinode-v1-storage-k8s-io","subsections":[]},{"section":"watch-csinode-v1-storage-k8s-io","subsections":[]},{"section":"list-csinode-v1-storage-k8s-io","subsections":[]},{"section":"read-csinode-v1-storage-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-csinode-v1-storage-k8s-io-strong-","subsections":[{"section":"delete-collection-csinode-v1-storage-k8s-io","subsections":[]},{"section":"delete-csinode-v1-storage-k8s-io","subsections":[]},{"section":"replace-csinode-v1-storage-k8s-io","subsections":[]},{"section":"patch-csinode-v1-storage-k8s-io","subsections":[]},{"section":"create-csinode-v1-storage-k8s-io","subsections":[]}]}]},{"section":"csidriver-v1-storage-k8s-io","subsections":[{"section":"-strong-read-operations-csidriver-v1-storage-k8s-io-strong-","subsections":[{"section":"watch-list-csidriver-v1-storage-k8s-io","subsections":[]},{"section":"watch-csidriver-v1-storage-k8s-io","subsections":[]},{"section":"list-csidriver-v1-storage-k8s-io","subsections":[]},{"section":"read-csidriver-v1-storage-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-csidriver-v1-storage-k8s-io-strong-","subsections":[{"section":"delete-collection-csidriver-v1-storage-k8s-io","subsections":[]},{"section":"delete-csidriver-v1-storage-k8s-io","subsections":[]},{"section":"replace-csidriver-v1-storage-k8s-io","subsections":[]},{"section":"patch-csidriver-v1-storage-k8s-io","subsections":[]},{"section":"create-csidriver-v1-storage-k8s-io","subsections":[]}]}]},{"section":"configmap-v1-core","subsections":[{"section":"-strong-read-operations-configmap-v1-core-strong-","subsections":[{"section":"watch-list-all-namespaces-configmap-v1-core","subsections":[]},{"section":"watch-list-configmap-v1-core","subsections":[]},{"section":"watch-configmap-v1-core","subsections":[]},{"section":"list-all-namespaces-configmap-v1-core","subsections":[]},{"section":"list-configmap-v1-core","subsections":[]},{"section":"read-configmap-v1-core","subsections":[]}]},{"section":"-strong-write-operations-configmap-v1-core-strong-","subsections":[{"section":"delete-collection-configmap-v1-core","subsections":[]},{"section":"delete-configmap-v1-core","subsections":[]},{"section":"replace-configmap-v1-core","subsections":[]},{"section":"patch-configmap-v1-core","subsections":[]},{"section":"create-configmap-v1-core","subsections":[]}]}]},{"section":"-strong-config-and-storage-apis-strong-","subsections":[]},{"section":"service-v1-core","subsections":[{"section":"-strong-proxy-operations-service-v1-core-strong-","subsections":[{"section":"replace-connect-proxy-path-service-v1-core","subsections":[]},{"section":"replace-connect-proxy-service-v1-core","subsections":[]},{"section":"head-connect-proxy-path-service-v1-core","subsections":[]},{"section":"head-connect-proxy-service-v1-core","subsections":[]},{"section":"get-connect-proxy-path-service-v1-core","subsections":[]},{"section":"get-connect-proxy-service-v1-core","subsections":[]},{"section":"delete-connect-proxy-path-service-v1-core","subsections":[]},{"section":"delete-connect-proxy-service-v1-core","subsections":[]},{"section":"create-connect-proxy-path-service-v1-core","subsections":[]},{"section":"create-connect-proxy-service-v1-core","subsections":[]}]},{"section":"-strong-status-operations-service-v1-core-strong-","subsections":[{"section":"replace-status-service-v1-core","subsections":[]},{"section":"read-status-service-v1-core","subsections":[]},{"section":"patch-status-service-v1-core","subsections":[]}]},{"section":"-strong-read-operations-service-v1-core-strong-","subsections":[{"section":"watch-list-all-namespaces-service-v1-core","subsections":[]},{"section":"watch-list-service-v1-core","subsections":[]},{"section":"watch-service-v1-core","subsections":[]},{"section":"list-all-namespaces-service-v1-core","subsections":[]},{"section":"list-service-v1-core","subsections":[]},{"section":"read-service-v1-core","subsections":[]}]},{"section":"-strong-write-operations-service-v1-core-strong-","subsections":[{"section":"delete-service-v1-core","subsections":[]},{"section":"replace-service-v1-core","subsections":[]},{"section":"patch-service-v1-core","subsections":[]},{"section":"create-service-v1-core","subsections":[]}]}]},{"section":"ingressclass-v1-networking-k8s-io","subsections":[{"section":"-strong-read-operations-ingressclass-v1-networking-k8s-io-strong-","subsections":[{"section":"watch-list-ingressclass-v1-networking-k8s-io","subsections":[]},{"section":"watch-ingressclass-v1-networking-k8s-io","subsections":[]},{"section":"list-ingressclass-v1-networking-k8s-io","subsections":[]},{"section":"read-ingressclass-v1-networking-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-ingressclass-v1-networking-k8s-io-strong-","subsections":[{"section":"delete-collection-ingressclass-v1-networking-k8s-io","subsections":[]},{"section":"delete-ingressclass-v1-networking-k8s-io","subsections":[]},{"section":"replace-ingressclass-v1-networking-k8s-io","subsections":[]},{"section":"patch-ingressclass-v1-networking-k8s-io","subsections":[]},{"section":"create-ingressclass-v1-networking-k8s-io","subsections":[]}]}]},{"section":"ingress-v1-networking-k8s-io","subsections":[{"section":"-strong-status-operations-ingress-v1-networking-k8s-io-strong-","subsections":[{"section":"replace-status-ingress-v1-networking-k8s-io","subsections":[]},{"section":"read-status-ingress-v1-networking-k8s-io","subsections":[]},{"section":"patch-status-ingress-v1-networking-k8s-io","subsections":[]}]},{"section":"-strong-read-operations-ingress-v1-networking-k8s-io-strong-","subsections":[{"section":"watch-list-all-namespaces-ingress-v1-networking-k8s-io","subsections":[]},{"section":"watch-list-ingress-v1-networking-k8s-io","subsections":[]},{"section":"watch-ingress-v1-networking-k8s-io","subsections":[]},{"section":"list-all-namespaces-ingress-v1-networking-k8s-io","subsections":[]},{"section":"list-ingress-v1-networking-k8s-io","subsections":[]},{"section":"read-ingress-v1-networking-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-ingress-v1-networking-k8s-io-strong-","subsections":[{"section":"delete-collection-ingress-v1-networking-k8s-io","subsections":[]},{"section":"delete-ingress-v1-networking-k8s-io","subsections":[]},{"section":"replace-ingress-v1-networking-k8s-io","subsections":[]},{"section":"patch-ingress-v1-networking-k8s-io","subsections":[]},{"section":"create-ingress-v1-networking-k8s-io","subsections":[]}]}]},{"section":"endpointslice-v1beta1-discovery-k8s-io","subsections":[{"section":"-strong-read-operations-endpointslice-v1beta1-discovery-k8s-io-strong-","subsections":[{"section":"watch-list-all-namespaces-endpointslice-v1beta1-discovery-k8s-io","subsections":[]},{"section":"watch-list-endpointslice-v1beta1-discovery-k8s-io","subsections":[]},{"section":"watch-endpointslice-v1beta1-discovery-k8s-io","subsections":[]},{"section":"list-all-namespaces-endpointslice-v1beta1-discovery-k8s-io","subsections":[]},{"section":"list-endpointslice-v1beta1-discovery-k8s-io","subsections":[]},{"section":"read-endpointslice-v1beta1-discovery-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-endpointslice-v1beta1-discovery-k8s-io-strong-","subsections":[{"section":"delete-collection-endpointslice-v1beta1-discovery-k8s-io","subsections":[]},{"section":"delete-endpointslice-v1beta1-discovery-k8s-io","subsections":[]},{"section":"replace-endpointslice-v1beta1-discovery-k8s-io","subsections":[]},{"section":"patch-endpointslice-v1beta1-discovery-k8s-io","subsections":[]},{"section":"create-endpointslice-v1beta1-discovery-k8s-io","subsections":[]}]}]},{"section":"endpoints-v1-core","subsections":[{"section":"-strong-read-operations-endpoints-v1-core-strong-","subsections":[{"section":"watch-list-all-namespaces-endpoints-v1-core","subsections":[]},{"section":"watch-list-endpoints-v1-core","subsections":[]},{"section":"watch-endpoints-v1-core","subsections":[]},{"section":"list-all-namespaces-endpoints-v1-core","subsections":[]},{"section":"list-endpoints-v1-core","subsections":[]},{"section":"read-endpoints-v1-core","subsections":[]}]},{"section":"-strong-write-operations-endpoints-v1-core-strong-","subsections":[{"section":"delete-collection-endpoints-v1-core","subsections":[]},{"section":"delete-endpoints-v1-core","subsections":[]},{"section":"replace-endpoints-v1-core","subsections":[]},{"section":"patch-endpoints-v1-core","subsections":[]},{"section":"create-endpoints-v1-core","subsections":[]}]}]},{"section":"-strong-service-apis-strong-","subsections":[]},{"section":"statefulset-v1-apps","subsections":[{"section":"-strong-misc-operations-statefulset-v1-apps-strong-","subsections":[{"section":"patch-scale-statefulset-v1-apps","subsections":[]},{"section":"replace-scale-statefulset-v1-apps","subsections":[]},{"section":"read-scale-statefulset-v1-apps","subsections":[]}]},{"section":"-strong-status-operations-statefulset-v1-apps-strong-","subsections":[{"section":"replace-status-statefulset-v1-apps","subsections":[]},{"section":"read-status-statefulset-v1-apps","subsections":[]},{"section":"patch-status-statefulset-v1-apps","subsections":[]}]},{"section":"-strong-read-operations-statefulset-v1-apps-strong-","subsections":[{"section":"watch-list-all-namespaces-statefulset-v1-apps","subsections":[]},{"section":"watch-list-statefulset-v1-apps","subsections":[]},{"section":"watch-statefulset-v1-apps","subsections":[]},{"section":"list-all-namespaces-statefulset-v1-apps","subsections":[]},{"section":"list-statefulset-v1-apps","subsections":[]},{"section":"read-statefulset-v1-apps","subsections":[]}]},{"section":"-strong-write-operations-statefulset-v1-apps-strong-","subsections":[{"section":"delete-collection-statefulset-v1-apps","subsections":[]},{"section":"delete-statefulset-v1-apps","subsections":[]},{"section":"replace-statefulset-v1-apps","subsections":[]},{"section":"patch-statefulset-v1-apps","subsections":[]},{"section":"create-statefulset-v1-apps","subsections":[]}]}]},{"section":"replicationcontroller-v1-core","subsections":[{"section":"-strong-misc-operations-replicationcontroller-v1-core-strong-","subsections":[{"section":"patch-scale-replicationcontroller-v1-core","subsections":[]},{"section":"replace-scale-replicationcontroller-v1-core","subsections":[]},{"section":"read-scale-replicationcontroller-v1-core","subsections":[]}]},{"section":"-strong-status-operations-replicationcontroller-v1-core-strong-","subsections":[{"section":"replace-status-replicationcontroller-v1-core","subsections":[]},{"section":"read-status-replicationcontroller-v1-core","subsections":[]},{"section":"patch-status-replicationcontroller-v1-core","subsections":[]}]},{"section":"-strong-read-operations-replicationcontroller-v1-core-strong-","subsections":[{"section":"watch-list-all-namespaces-replicationcontroller-v1-core","subsections":[]},{"section":"watch-list-replicationcontroller-v1-core","subsections":[]},{"section":"watch-replicationcontroller-v1-core","subsections":[]},{"section":"list-all-namespaces-replicationcontroller-v1-core","subsections":[]},{"section":"list-replicationcontroller-v1-core","subsections":[]},{"section":"read-replicationcontroller-v1-core","subsections":[]}]},{"section":"-strong-write-operations-replicationcontroller-v1-core-strong-","subsections":[{"section":"delete-collection-replicationcontroller-v1-core","subsections":[]},{"section":"delete-replicationcontroller-v1-core","subsections":[]},{"section":"replace-replicationcontroller-v1-core","subsections":[]},{"section":"patch-replicationcontroller-v1-core","subsections":[]},{"section":"create-replicationcontroller-v1-core","subsections":[]}]}]},{"section":"replicaset-v1-apps","subsections":[{"section":"-strong-misc-operations-replicaset-v1-apps-strong-","subsections":[{"section":"patch-scale-replicaset-v1-apps","subsections":[]},{"section":"replace-scale-replicaset-v1-apps","subsections":[]},{"section":"read-scale-replicaset-v1-apps","subsections":[]}]},{"section":"-strong-status-operations-replicaset-v1-apps-strong-","subsections":[{"section":"replace-status-replicaset-v1-apps","subsections":[]},{"section":"read-status-replicaset-v1-apps","subsections":[]},{"section":"patch-status-replicaset-v1-apps","subsections":[]}]},{"section":"-strong-read-operations-replicaset-v1-apps-strong-","subsections":[{"section":"watch-list-all-namespaces-replicaset-v1-apps","subsections":[]},{"section":"watch-list-replicaset-v1-apps","subsections":[]},{"section":"watch-replicaset-v1-apps","subsections":[]},{"section":"list-all-namespaces-replicaset-v1-apps","subsections":[]},{"section":"list-replicaset-v1-apps","subsections":[]},{"section":"read-replicaset-v1-apps","subsections":[]}]},{"section":"-strong-write-operations-replicaset-v1-apps-strong-","subsections":[{"section":"delete-collection-replicaset-v1-apps","subsections":[]},{"section":"delete-replicaset-v1-apps","subsections":[]},{"section":"replace-replicaset-v1-apps","subsections":[]},{"section":"patch-replicaset-v1-apps","subsections":[]},{"section":"create-replicaset-v1-apps","subsections":[]}]}]},{"section":"pod-v1-core","subsections":[{"section":"-strong-misc-operations-pod-v1-core-strong-","subsections":[{"section":"read-log-pod-v1-core","subsections":[]}]},{"section":"-strong-proxy-operations-pod-v1-core-strong-","subsections":[{"section":"replace-connect-proxy-path-pod-v1-core","subsections":[]},{"section":"replace-connect-proxy-pod-v1-core","subsections":[]},{"section":"head-connect-proxy-path-pod-v1-core","subsections":[]},{"section":"head-connect-proxy-pod-v1-core","subsections":[]},{"section":"get-connect-proxy-path-pod-v1-core","subsections":[]},{"section":"get-connect-proxy-pod-v1-core","subsections":[]},{"section":"get-connect-portforward-pod-v1-core","subsections":[]},{"section":"delete-connect-proxy-path-pod-v1-core","subsections":[]},{"section":"delete-connect-proxy-pod-v1-core","subsections":[]},{"section":"create-connect-proxy-path-pod-v1-core","subsections":[]},{"section":"create-connect-proxy-pod-v1-core","subsections":[]},{"section":"create-connect-portforward-pod-v1-core","subsections":[]}]},{"section":"-strong-status-operations-pod-v1-core-strong-","subsections":[{"section":"replace-status-pod-v1-core","subsections":[]},{"section":"read-status-pod-v1-core","subsections":[]},{"section":"patch-status-pod-v1-core","subsections":[]}]},{"section":"-strong-read-operations-pod-v1-core-strong-","subsections":[{"section":"watch-list-all-namespaces-pod-v1-core","subsections":[]},{"section":"watch-list-pod-v1-core","subsections":[]},{"section":"watch-pod-v1-core","subsections":[]},{"section":"list-all-namespaces-pod-v1-core","subsections":[]},{"section":"list-pod-v1-core","subsections":[]},{"section":"read-pod-v1-core","subsections":[]}]},{"section":"-strong-write-operations-pod-v1-core-strong-","subsections":[{"section":"delete-collection-pod-v1-core","subsections":[]},{"section":"delete-pod-v1-core","subsections":[]},{"section":"replace-pod-v1-core","subsections":[]},{"section":"patch-pod-v1-core","subsections":[]},{"section":"create-eviction-pod-v1-core","subsections":[]},{"section":"create-pod-v1-core","subsections":[]}]}]},{"section":"job-v1-batch","subsections":[{"section":"-strong-status-operations-job-v1-batch-strong-","subsections":[{"section":"replace-status-job-v1-batch","subsections":[]},{"section":"read-status-job-v1-batch","subsections":[]},{"section":"patch-status-job-v1-batch","subsections":[]}]},{"section":"-strong-read-operations-job-v1-batch-strong-","subsections":[{"section":"watch-list-all-namespaces-job-v1-batch","subsections":[]},{"section":"watch-list-job-v1-batch","subsections":[]},{"section":"watch-job-v1-batch","subsections":[]},{"section":"list-all-namespaces-job-v1-batch","subsections":[]},{"section":"list-job-v1-batch","subsections":[]},{"section":"read-job-v1-batch","subsections":[]}]},{"section":"-strong-write-operations-job-v1-batch-strong-","subsections":[{"section":"delete-collection-job-v1-batch","subsections":[]},{"section":"delete-job-v1-batch","subsections":[]},{"section":"replace-job-v1-batch","subsections":[]},{"section":"patch-job-v1-batch","subsections":[]},{"section":"create-job-v1-batch","subsections":[]}]}]},{"section":"deployment-v1-apps","subsections":[{"section":"-strong-misc-operations-deployment-v1-apps-strong-","subsections":[{"section":"patch-scale-deployment-v1-apps","subsections":[]},{"section":"replace-scale-deployment-v1-apps","subsections":[]},{"section":"read-scale-deployment-v1-apps","subsections":[]}]},{"section":"-strong-status-operations-deployment-v1-apps-strong-","subsections":[{"section":"replace-status-deployment-v1-apps","subsections":[]},{"section":"read-status-deployment-v1-apps","subsections":[]},{"section":"patch-status-deployment-v1-apps","subsections":[]}]},{"section":"-strong-read-operations-deployment-v1-apps-strong-","subsections":[{"section":"watch-list-all-namespaces-deployment-v1-apps","subsections":[]},{"section":"watch-list-deployment-v1-apps","subsections":[]},{"section":"watch-deployment-v1-apps","subsections":[]},{"section":"list-all-namespaces-deployment-v1-apps","subsections":[]},{"section":"list-deployment-v1-apps","subsections":[]},{"section":"read-deployment-v1-apps","subsections":[]}]},{"section":"-strong-write-operations-deployment-v1-apps-strong-","subsections":[{"section":"delete-collection-deployment-v1-apps","subsections":[]},{"section":"delete-deployment-v1-apps","subsections":[]},{"section":"replace-deployment-v1-apps","subsections":[]},{"section":"patch-deployment-v1-apps","subsections":[]},{"section":"create-deployment-v1-apps","subsections":[]}]}]},{"section":"daemonset-v1-apps","subsections":[{"section":"-strong-status-operations-daemonset-v1-apps-strong-","subsections":[{"section":"replace-status-daemonset-v1-apps","subsections":[]},{"section":"read-status-daemonset-v1-apps","subsections":[]},{"section":"patch-status-daemonset-v1-apps","subsections":[]}]},{"section":"-strong-read-operations-daemonset-v1-apps-strong-","subsections":[{"section":"watch-list-all-namespaces-daemonset-v1-apps","subsections":[]},{"section":"watch-list-daemonset-v1-apps","subsections":[]},{"section":"watch-daemonset-v1-apps","subsections":[]},{"section":"list-all-namespaces-daemonset-v1-apps","subsections":[]},{"section":"list-daemonset-v1-apps","subsections":[]},{"section":"read-daemonset-v1-apps","subsections":[]}]},{"section":"-strong-write-operations-daemonset-v1-apps-strong-","subsections":[{"section":"delete-collection-daemonset-v1-apps","subsections":[]},{"section":"delete-daemonset-v1-apps","subsections":[]},{"section":"replace-daemonset-v1-apps","subsections":[]},{"section":"patch-daemonset-v1-apps","subsections":[]},{"section":"create-daemonset-v1-apps","subsections":[]}]}]},{"section":"cronjob-v1beta1-batch","subsections":[{"section":"-strong-status-operations-cronjob-v1beta1-batch-strong-","subsections":[{"section":"replace-status-cronjob-v1beta1-batch","subsections":[]},{"section":"read-status-cronjob-v1beta1-batch","subsections":[]},{"section":"patch-status-cronjob-v1beta1-batch","subsections":[]}]},{"section":"-strong-read-operations-cronjob-v1beta1-batch-strong-","subsections":[{"section":"watch-list-all-namespaces-cronjob-v1beta1-batch","subsections":[]},{"section":"watch-list-cronjob-v1beta1-batch","subsections":[]},{"section":"watch-cronjob-v1beta1-batch","subsections":[]},{"section":"list-all-namespaces-cronjob-v1beta1-batch","subsections":[]},{"section":"list-cronjob-v1beta1-batch","subsections":[]},{"section":"read-cronjob-v1beta1-batch","subsections":[]}]},{"section":"-strong-write-operations-cronjob-v1beta1-batch-strong-","subsections":[{"section":"delete-collection-cronjob-v1beta1-batch","subsections":[]},{"section":"delete-cronjob-v1beta1-batch","subsections":[]},{"section":"replace-cronjob-v1beta1-batch","subsections":[]},{"section":"patch-cronjob-v1beta1-batch","subsections":[]},{"section":"create-cronjob-v1beta1-batch","subsections":[]}]}]},{"section":"container-v1-core","subsections":[]},{"section":"-strong-workloads-apis-strong-","subsections":[]},{"section":"-strong-api-groups-strong-","subsections":[]},{"section":"-strong-api-overview-strong-","subsections":[]}],"flatToc":["webhookclientconfig-v1beta1-apiextensions-k8s-io","webhookclientconfig-v1beta1-admissionregistration-k8s-io","webhookclientconfig-v1-apiextensions-k8s-io","volumenoderesources-v1beta1-storage-k8s-io","volumeerror-v1alpha1-storage-k8s-io","volumeerror-v1beta1-storage-k8s-io","volumeattachmentsource-v1alpha1-storage-k8s-io","volumeattachmentsource-v1beta1-storage-k8s-io","watch-list-volumeattachment-v1alpha1-storage-k8s-io","watch-volumeattachment-v1alpha1-storage-k8s-io","list-volumeattachment-v1alpha1-storage-k8s-io","read-volumeattachment-v1alpha1-storage-k8s-io","-strong-read-operations-volumeattachment-v1alpha1-storage-k8s-io-strong-","delete-collection-volumeattachment-v1alpha1-storage-k8s-io","delete-volumeattachment-v1alpha1-storage-k8s-io","replace-volumeattachment-v1alpha1-storage-k8s-io","patch-volumeattachment-v1alpha1-storage-k8s-io","create-volumeattachment-v1alpha1-storage-k8s-io","-strong-write-operations-volumeattachment-v1alpha1-storage-k8s-io-strong-","volumeattachment-v1alpha1-storage-k8s-io","watch-list-volumeattachment-v1beta1-storage-k8s-io","watch-volumeattachment-v1beta1-storage-k8s-io","list-volumeattachment-v1beta1-storage-k8s-io","read-volumeattachment-v1beta1-storage-k8s-io","-strong-read-operations-volumeattachment-v1beta1-storage-k8s-io-strong-","delete-collection-volumeattachment-v1beta1-storage-k8s-io","delete-volumeattachment-v1beta1-storage-k8s-io","replace-volumeattachment-v1beta1-storage-k8s-io","patch-volumeattachment-v1beta1-storage-k8s-io","create-volumeattachment-v1beta1-storage-k8s-io","-strong-write-operations-volumeattachment-v1beta1-storage-k8s-io-strong-","volumeattachment-v1beta1-storage-k8s-io","watch-list-validatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","watch-validatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","list-validatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","read-validatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","-strong-read-operations-validatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io-strong-","delete-collection-validatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","delete-validatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","replace-validatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","patch-validatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","create-validatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","-strong-write-operations-validatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io-strong-","validatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","validatingwebhook-v1beta1-admissionregistration-k8s-io","userinfo-v1beta1-authentication-k8s-io","create-tokenreview-v1beta1-authentication-k8s-io","-strong-write-operations-tokenreview-v1beta1-authentication-k8s-io-strong-","tokenreview-v1beta1-authentication-k8s-io","tokenrequest-v1beta1-storage-k8s-io","tokenrequest-v1-storage-k8s-io","subjectrulesreviewstatus-v1beta1-authorization-k8s-io","create-subjectaccessreview-v1beta1-authorization-k8s-io","-strong-write-operations-subjectaccessreview-v1beta1-authorization-k8s-io-strong-","subjectaccessreview-v1beta1-authorization-k8s-io","subject-v1alpha1-rbac-authorization-k8s-io","subject-v1beta1-rbac-authorization-k8s-io","subject-v1-rbac-authorization-k8s-io","watch-list-storageclass-v1beta1-storage-k8s-io","watch-storageclass-v1beta1-storage-k8s-io","list-storageclass-v1beta1-storage-k8s-io","read-storageclass-v1beta1-storage-k8s-io","-strong-read-operations-storageclass-v1beta1-storage-k8s-io-strong-","delete-collection-storageclass-v1beta1-storage-k8s-io","delete-storageclass-v1beta1-storage-k8s-io","replace-storageclass-v1beta1-storage-k8s-io","patch-storageclass-v1beta1-storage-k8s-io","create-storageclass-v1beta1-storage-k8s-io","-strong-write-operations-storageclass-v1beta1-storage-k8s-io-strong-","storageclass-v1beta1-storage-k8s-io","servicereference-v1beta1-apiregistration-k8s-io","servicereference-v1beta1-apiextensions-k8s-io","servicereference-v1beta1-admissionregistration-k8s-io","servicereference-v1-apiregistration-k8s-io","servicereference-v1-apiextensions-k8s-io","create-selfsubjectrulesreview-v1beta1-authorization-k8s-io","-strong-write-operations-selfsubjectrulesreview-v1beta1-authorization-k8s-io-strong-","selfsubjectrulesreview-v1beta1-authorization-k8s-io","create-selfsubjectaccessreview-v1beta1-authorization-k8s-io","-strong-write-operations-selfsubjectaccessreview-v1beta1-authorization-k8s-io-strong-","selfsubjectaccessreview-v1beta1-authorization-k8s-io","scheduling-v1alpha1-node-k8s-io","scheduling-v1beta1-node-k8s-io","watch-list-runtimeclass-v1alpha1-node-k8s-io","watch-runtimeclass-v1alpha1-node-k8s-io","list-runtimeclass-v1alpha1-node-k8s-io","read-runtimeclass-v1alpha1-node-k8s-io","-strong-read-operations-runtimeclass-v1alpha1-node-k8s-io-strong-","delete-collection-runtimeclass-v1alpha1-node-k8s-io","delete-runtimeclass-v1alpha1-node-k8s-io","replace-runtimeclass-v1alpha1-node-k8s-io","patch-runtimeclass-v1alpha1-node-k8s-io","create-runtimeclass-v1alpha1-node-k8s-io","-strong-write-operations-runtimeclass-v1alpha1-node-k8s-io-strong-","runtimeclass-v1alpha1-node-k8s-io","watch-list-runtimeclass-v1beta1-node-k8s-io","watch-runtimeclass-v1beta1-node-k8s-io","list-runtimeclass-v1beta1-node-k8s-io","read-runtimeclass-v1beta1-node-k8s-io","-strong-read-operations-runtimeclass-v1beta1-node-k8s-io-strong-","delete-collection-runtimeclass-v1beta1-node-k8s-io","delete-runtimeclass-v1beta1-node-k8s-io","replace-runtimeclass-v1beta1-node-k8s-io","patch-runtimeclass-v1beta1-node-k8s-io","create-runtimeclass-v1beta1-node-k8s-io","-strong-write-operations-runtimeclass-v1beta1-node-k8s-io-strong-","runtimeclass-v1beta1-node-k8s-io","rulewithoperations-v1beta1-admissionregistration-k8s-io","roleref-v1alpha1-rbac-authorization-k8s-io","roleref-v1beta1-rbac-authorization-k8s-io","watch-list-all-namespaces-rolebinding-v1alpha1-rbac-authorization-k8s-io","watch-list-rolebinding-v1alpha1-rbac-authorization-k8s-io","watch-rolebinding-v1alpha1-rbac-authorization-k8s-io","list-all-namespaces-rolebinding-v1alpha1-rbac-authorization-k8s-io","list-rolebinding-v1alpha1-rbac-authorization-k8s-io","read-rolebinding-v1alpha1-rbac-authorization-k8s-io","-strong-read-operations-rolebinding-v1alpha1-rbac-authorization-k8s-io-strong-","delete-collection-rolebinding-v1alpha1-rbac-authorization-k8s-io","delete-rolebinding-v1alpha1-rbac-authorization-k8s-io","replace-rolebinding-v1alpha1-rbac-authorization-k8s-io","patch-rolebinding-v1alpha1-rbac-authorization-k8s-io","create-rolebinding-v1alpha1-rbac-authorization-k8s-io","-strong-write-operations-rolebinding-v1alpha1-rbac-authorization-k8s-io-strong-","rolebinding-v1alpha1-rbac-authorization-k8s-io","watch-list-all-namespaces-rolebinding-v1beta1-rbac-authorization-k8s-io","watch-list-rolebinding-v1beta1-rbac-authorization-k8s-io","watch-rolebinding-v1beta1-rbac-authorization-k8s-io","list-all-namespaces-rolebinding-v1beta1-rbac-authorization-k8s-io","list-rolebinding-v1beta1-rbac-authorization-k8s-io","read-rolebinding-v1beta1-rbac-authorization-k8s-io","-strong-read-operations-rolebinding-v1beta1-rbac-authorization-k8s-io-strong-","delete-collection-rolebinding-v1beta1-rbac-authorization-k8s-io","delete-rolebinding-v1beta1-rbac-authorization-k8s-io","replace-rolebinding-v1beta1-rbac-authorization-k8s-io","patch-rolebinding-v1beta1-rbac-authorization-k8s-io","create-rolebinding-v1beta1-rbac-authorization-k8s-io","-strong-write-operations-rolebinding-v1beta1-rbac-authorization-k8s-io-strong-","rolebinding-v1beta1-rbac-authorization-k8s-io","watch-list-all-namespaces-role-v1alpha1-rbac-authorization-k8s-io","watch-list-role-v1alpha1-rbac-authorization-k8s-io","watch-role-v1alpha1-rbac-authorization-k8s-io","list-all-namespaces-role-v1alpha1-rbac-authorization-k8s-io","list-role-v1alpha1-rbac-authorization-k8s-io","read-role-v1alpha1-rbac-authorization-k8s-io","-strong-read-operations-role-v1alpha1-rbac-authorization-k8s-io-strong-","delete-collection-role-v1alpha1-rbac-authorization-k8s-io","delete-role-v1alpha1-rbac-authorization-k8s-io","replace-role-v1alpha1-rbac-authorization-k8s-io","patch-role-v1alpha1-rbac-authorization-k8s-io","create-role-v1alpha1-rbac-authorization-k8s-io","-strong-write-operations-role-v1alpha1-rbac-authorization-k8s-io-strong-","role-v1alpha1-rbac-authorization-k8s-io","watch-list-all-namespaces-role-v1beta1-rbac-authorization-k8s-io","watch-list-role-v1beta1-rbac-authorization-k8s-io","watch-role-v1beta1-rbac-authorization-k8s-io","list-all-namespaces-role-v1beta1-rbac-authorization-k8s-io","list-role-v1beta1-rbac-authorization-k8s-io","read-role-v1beta1-rbac-authorization-k8s-io","-strong-read-operations-role-v1beta1-rbac-authorization-k8s-io-strong-","delete-collection-role-v1beta1-rbac-authorization-k8s-io","delete-role-v1beta1-rbac-authorization-k8s-io","replace-role-v1beta1-rbac-authorization-k8s-io","patch-role-v1beta1-rbac-authorization-k8s-io","create-role-v1beta1-rbac-authorization-k8s-io","-strong-write-operations-role-v1beta1-rbac-authorization-k8s-io-strong-","role-v1beta1-rbac-authorization-k8s-io","resourcerule-v1beta1-authorization-k8s-io","resourcemetricstatus-v2beta1-autoscaling","resourcemetricsource-v2beta1-autoscaling","resourceattributes-v1beta1-authorization-k8s-io","watch-list-priorityclass-v1alpha1-scheduling-k8s-io","watch-priorityclass-v1alpha1-scheduling-k8s-io","list-priorityclass-v1alpha1-scheduling-k8s-io","read-priorityclass-v1alpha1-scheduling-k8s-io","-strong-read-operations-priorityclass-v1alpha1-scheduling-k8s-io-strong-","delete-collection-priorityclass-v1alpha1-scheduling-k8s-io","delete-priorityclass-v1alpha1-scheduling-k8s-io","replace-priorityclass-v1alpha1-scheduling-k8s-io","patch-priorityclass-v1alpha1-scheduling-k8s-io","create-priorityclass-v1alpha1-scheduling-k8s-io","-strong-write-operations-priorityclass-v1alpha1-scheduling-k8s-io-strong-","priorityclass-v1alpha1-scheduling-k8s-io","watch-list-priorityclass-v1beta1-scheduling-k8s-io","watch-priorityclass-v1beta1-scheduling-k8s-io","list-priorityclass-v1beta1-scheduling-k8s-io","read-priorityclass-v1beta1-scheduling-k8s-io","-strong-read-operations-priorityclass-v1beta1-scheduling-k8s-io-strong-","delete-collection-priorityclass-v1beta1-scheduling-k8s-io","delete-priorityclass-v1beta1-scheduling-k8s-io","replace-priorityclass-v1beta1-scheduling-k8s-io","patch-priorityclass-v1beta1-scheduling-k8s-io","create-priorityclass-v1beta1-scheduling-k8s-io","-strong-write-operations-priorityclass-v1beta1-scheduling-k8s-io-strong-","priorityclass-v1beta1-scheduling-k8s-io","policyrule-v1alpha1-rbac-authorization-k8s-io","policyrule-v1beta1-rbac-authorization-k8s-io","podsmetricstatus-v2beta1-autoscaling","podsmetricsource-v2beta1-autoscaling","replace-status-poddisruptionbudget-v1beta1-policy","read-status-poddisruptionbudget-v1beta1-policy","patch-status-poddisruptionbudget-v1beta1-policy","-strong-status-operations-poddisruptionbudget-v1beta1-policy-strong-","watch-list-all-namespaces-poddisruptionbudget-v1beta1-policy","watch-list-poddisruptionbudget-v1beta1-policy","watch-poddisruptionbudget-v1beta1-policy","list-all-namespaces-poddisruptionbudget-v1beta1-policy","list-poddisruptionbudget-v1beta1-policy","read-poddisruptionbudget-v1beta1-policy","-strong-read-operations-poddisruptionbudget-v1beta1-policy-strong-","delete-collection-poddisruptionbudget-v1beta1-policy","delete-poddisruptionbudget-v1beta1-policy","replace-poddisruptionbudget-v1beta1-policy","patch-poddisruptionbudget-v1beta1-policy","create-poddisruptionbudget-v1beta1-policy","-strong-write-operations-poddisruptionbudget-v1beta1-policy-strong-","poddisruptionbudget-v1beta1-policy","overhead-v1alpha1-node-k8s-io","overhead-v1beta1-node-k8s-io","objectmetricstatus-v2beta1-autoscaling","objectmetricsource-v2beta1-autoscaling","nonresourcerule-v1beta1-authorization-k8s-io","nonresourceattributes-v1beta1-authorization-k8s-io","watch-list-mutatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","watch-mutatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","list-mutatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","read-mutatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","-strong-read-operations-mutatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io-strong-","delete-collection-mutatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","delete-mutatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","replace-mutatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","patch-mutatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","create-mutatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","-strong-write-operations-mutatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io-strong-","mutatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","mutatingwebhook-v1beta1-admissionregistration-k8s-io","metricstatus-v2beta1-autoscaling","metricspec-v2beta1-autoscaling","create-localsubjectaccessreview-v1beta1-authorization-k8s-io","-strong-write-operations-localsubjectaccessreview-v1beta1-authorization-k8s-io-strong-","localsubjectaccessreview-v1beta1-authorization-k8s-io","watch-list-all-namespaces-lease-v1beta1-coordination-k8s-io","watch-list-lease-v1beta1-coordination-k8s-io","watch-lease-v1beta1-coordination-k8s-io","list-all-namespaces-lease-v1beta1-coordination-k8s-io","list-lease-v1beta1-coordination-k8s-io","read-lease-v1beta1-coordination-k8s-io","-strong-read-operations-lease-v1beta1-coordination-k8s-io-strong-","delete-collection-lease-v1beta1-coordination-k8s-io","delete-lease-v1beta1-coordination-k8s-io","replace-lease-v1beta1-coordination-k8s-io","patch-lease-v1beta1-coordination-k8s-io","create-lease-v1beta1-coordination-k8s-io","-strong-write-operations-lease-v1beta1-coordination-k8s-io-strong-","lease-v1beta1-coordination-k8s-io","jobtemplatespec-v1beta1-batch","jsonschemapropsorbool-v1beta1-apiextensions-k8s-io","jsonschemapropsorarray-v1beta1-apiextensions-k8s-io","jsonschemaprops-v1beta1-apiextensions-k8s-io","json-v1beta1-apiextensions-k8s-io","ingresstls-v1beta1-networking-k8s-io","ingresstls-v1beta1-extensions","ingressrule-v1beta1-networking-k8s-io","ingressrule-v1beta1-extensions","ingressclassparametersreference-v1beta1-networking-k8s-io","watch-list-ingressclass-v1beta1-networking-k8s-io","watch-ingressclass-v1beta1-networking-k8s-io","list-ingressclass-v1beta1-networking-k8s-io","read-ingressclass-v1beta1-networking-k8s-io","-strong-read-operations-ingressclass-v1beta1-networking-k8s-io-strong-","delete-collection-ingressclass-v1beta1-networking-k8s-io","delete-ingressclass-v1beta1-networking-k8s-io","replace-ingressclass-v1beta1-networking-k8s-io","patch-ingressclass-v1beta1-networking-k8s-io","create-ingressclass-v1beta1-networking-k8s-io","-strong-write-operations-ingressclass-v1beta1-networking-k8s-io-strong-","ingressclass-v1beta1-networking-k8s-io","ingressbackend-v1beta1-networking-k8s-io","ingressbackend-v1beta1-extensions","replace-status-ingress-v1beta1-networking-k8s-io","read-status-ingress-v1beta1-networking-k8s-io","patch-status-ingress-v1beta1-networking-k8s-io","-strong-status-operations-ingress-v1beta1-networking-k8s-io-strong-","watch-list-all-namespaces-ingress-v1beta1-networking-k8s-io","watch-list-ingress-v1beta1-networking-k8s-io","watch-ingress-v1beta1-networking-k8s-io","list-all-namespaces-ingress-v1beta1-networking-k8s-io","list-ingress-v1beta1-networking-k8s-io","read-ingress-v1beta1-networking-k8s-io","-strong-read-operations-ingress-v1beta1-networking-k8s-io-strong-","delete-collection-ingress-v1beta1-networking-k8s-io","delete-ingress-v1beta1-networking-k8s-io","replace-ingress-v1beta1-networking-k8s-io","patch-ingress-v1beta1-networking-k8s-io","create-ingress-v1beta1-networking-k8s-io","-strong-write-operations-ingress-v1beta1-networking-k8s-io-strong-","ingress-v1beta1-networking-k8s-io","replace-status-ingress-v1beta1-extensions","read-status-ingress-v1beta1-extensions","patch-status-ingress-v1beta1-extensions","-strong-status-operations-ingress-v1beta1-extensions-strong-","watch-list-all-namespaces-ingress-v1beta1-extensions","watch-list-ingress-v1beta1-extensions","watch-ingress-v1beta1-extensions","list-all-namespaces-ingress-v1beta1-extensions","list-ingress-v1beta1-extensions","read-ingress-v1beta1-extensions","-strong-read-operations-ingress-v1beta1-extensions-strong-","delete-collection-ingress-v1beta1-extensions","delete-ingress-v1beta1-extensions","replace-ingress-v1beta1-extensions","patch-ingress-v1beta1-extensions","create-ingress-v1beta1-extensions","-strong-write-operations-ingress-v1beta1-extensions-strong-","ingress-v1beta1-extensions","horizontalpodautoscalercondition-v2beta1-autoscaling","replace-status-horizontalpodautoscaler-v2beta1-autoscaling","read-status-horizontalpodautoscaler-v2beta1-autoscaling","patch-status-horizontalpodautoscaler-v2beta1-autoscaling","-strong-status-operations-horizontalpodautoscaler-v2beta1-autoscaling-strong-","watch-list-all-namespaces-horizontalpodautoscaler-v2beta1-autoscaling","watch-list-horizontalpodautoscaler-v2beta1-autoscaling","watch-horizontalpodautoscaler-v2beta1-autoscaling","list-all-namespaces-horizontalpodautoscaler-v2beta1-autoscaling","list-horizontalpodautoscaler-v2beta1-autoscaling","read-horizontalpodautoscaler-v2beta1-autoscaling","-strong-read-operations-horizontalpodautoscaler-v2beta1-autoscaling-strong-","delete-collection-horizontalpodautoscaler-v2beta1-autoscaling","delete-horizontalpodautoscaler-v2beta1-autoscaling","replace-horizontalpodautoscaler-v2beta1-autoscaling","patch-horizontalpodautoscaler-v2beta1-autoscaling","create-horizontalpodautoscaler-v2beta1-autoscaling","-strong-write-operations-horizontalpodautoscaler-v2beta1-autoscaling-strong-","horizontalpodautoscaler-v2beta1-autoscaling","replace-status-horizontalpodautoscaler-v2beta2-autoscaling","read-status-horizontalpodautoscaler-v2beta2-autoscaling","patch-status-horizontalpodautoscaler-v2beta2-autoscaling","-strong-status-operations-horizontalpodautoscaler-v2beta2-autoscaling-strong-","watch-list-all-namespaces-horizontalpodautoscaler-v2beta2-autoscaling","watch-list-horizontalpodautoscaler-v2beta2-autoscaling","watch-horizontalpodautoscaler-v2beta2-autoscaling","list-all-namespaces-horizontalpodautoscaler-v2beta2-autoscaling","list-horizontalpodautoscaler-v2beta2-autoscaling","read-horizontalpodautoscaler-v2beta2-autoscaling","-strong-read-operations-horizontalpodautoscaler-v2beta2-autoscaling-strong-","delete-collection-horizontalpodautoscaler-v2beta2-autoscaling","delete-horizontalpodautoscaler-v2beta2-autoscaling","replace-horizontalpodautoscaler-v2beta2-autoscaling","patch-horizontalpodautoscaler-v2beta2-autoscaling","create-horizontalpodautoscaler-v2beta2-autoscaling","-strong-write-operations-horizontalpodautoscaler-v2beta2-autoscaling-strong-","horizontalpodautoscaler-v2beta2-autoscaling","httpingressrulevalue-v1beta1-networking-k8s-io","httpingressrulevalue-v1beta1-extensions","httpingresspath-v1beta1-networking-k8s-io","httpingresspath-v1beta1-extensions","forzone-v1beta1-discovery-k8s-io","externalmetricstatus-v2beta1-autoscaling","externalmetricsource-v2beta1-autoscaling","externaldocumentation-v1beta1-apiextensions-k8s-io","eventseries-v1beta1-events-k8s-io","eventseries-v1-events-k8s-io","watch-list-all-namespaces-event-v1beta1-events-k8s-io","watch-list-event-v1beta1-events-k8s-io","watch-event-v1beta1-events-k8s-io","list-all-namespaces-event-v1beta1-events-k8s-io","list-event-v1beta1-events-k8s-io","read-event-v1beta1-events-k8s-io","-strong-read-operations-event-v1beta1-events-k8s-io-strong-","delete-collection-event-v1beta1-events-k8s-io","delete-event-v1beta1-events-k8s-io","replace-event-v1beta1-events-k8s-io","patch-event-v1beta1-events-k8s-io","create-event-v1beta1-events-k8s-io","-strong-write-operations-event-v1beta1-events-k8s-io-strong-","event-v1beta1-events-k8s-io","watch-list-all-namespaces-event-v1-events-k8s-io","watch-list-event-v1-events-k8s-io","watch-event-v1-events-k8s-io","list-all-namespaces-event-v1-events-k8s-io","list-event-v1-events-k8s-io","read-event-v1-events-k8s-io","-strong-read-operations-event-v1-events-k8s-io-strong-","delete-collection-event-v1-events-k8s-io","delete-event-v1-events-k8s-io","replace-event-v1-events-k8s-io","patch-event-v1-events-k8s-io","create-event-v1-events-k8s-io","-strong-write-operations-event-v1-events-k8s-io-strong-","event-v1-events-k8s-io","watch-list-all-namespaces-endpointslice-v1beta1-discovery-k8s-io","watch-list-endpointslice-v1beta1-discovery-k8s-io","watch-endpointslice-v1beta1-discovery-k8s-io","list-all-namespaces-endpointslice-v1beta1-discovery-k8s-io","list-endpointslice-v1beta1-discovery-k8s-io","read-endpointslice-v1beta1-discovery-k8s-io","-strong-read-operations-endpointslice-v1beta1-discovery-k8s-io-strong-","delete-collection-endpointslice-v1beta1-discovery-k8s-io","delete-endpointslice-v1beta1-discovery-k8s-io","replace-endpointslice-v1beta1-discovery-k8s-io","patch-endpointslice-v1beta1-discovery-k8s-io","create-endpointslice-v1beta1-discovery-k8s-io","-strong-write-operations-endpointslice-v1beta1-discovery-k8s-io-strong-","endpointslice-v1beta1-discovery-k8s-io","endpointport-v1beta1-discovery-k8s-io","endpointport-v1-discovery-k8s-io","endpointhints-v1beta1-discovery-k8s-io","endpointconditions-v1beta1-discovery-k8s-io","endpoint-v1beta1-discovery-k8s-io","customresourcevalidation-v1beta1-apiextensions-k8s-io","customresourcesubresources-v1beta1-apiextensions-k8s-io","customresourcesubresourcestatus-v1beta1-apiextensions-k8s-io","customresourcesubresourcescale-v1beta1-apiextensions-k8s-io","customresourcedefinitionversion-v1beta1-apiextensions-k8s-io","customresourcedefinitionnames-v1beta1-apiextensions-k8s-io","customresourcedefinitioncondition-v1beta1-apiextensions-k8s-io","replace-status-customresourcedefinition-v1beta1-apiextensions-k8s-io","read-status-customresourcedefinition-v1beta1-apiextensions-k8s-io","patch-status-customresourcedefinition-v1beta1-apiextensions-k8s-io","-strong-status-operations-customresourcedefinition-v1beta1-apiextensions-k8s-io-strong-","watch-list-customresourcedefinition-v1beta1-apiextensions-k8s-io","watch-customresourcedefinition-v1beta1-apiextensions-k8s-io","list-customresourcedefinition-v1beta1-apiextensions-k8s-io","read-customresourcedefinition-v1beta1-apiextensions-k8s-io","-strong-read-operations-customresourcedefinition-v1beta1-apiextensions-k8s-io-strong-","delete-collection-customresourcedefinition-v1beta1-apiextensions-k8s-io","delete-customresourcedefinition-v1beta1-apiextensions-k8s-io","replace-customresourcedefinition-v1beta1-apiextensions-k8s-io","patch-customresourcedefinition-v1beta1-apiextensions-k8s-io","create-customresourcedefinition-v1beta1-apiextensions-k8s-io","-strong-write-operations-customresourcedefinition-v1beta1-apiextensions-k8s-io-strong-","customresourcedefinition-v1beta1-apiextensions-k8s-io","customresourceconversion-v1beta1-apiextensions-k8s-io","customresourcecolumndefinition-v1beta1-apiextensions-k8s-io","crossversionobjectreference-v2beta1-autoscaling","crossversionobjectreference-v2beta2-autoscaling","replace-status-cronjob-v1beta1-batch","read-status-cronjob-v1beta1-batch","patch-status-cronjob-v1beta1-batch","-strong-status-operations-cronjob-v1beta1-batch-strong-","watch-list-all-namespaces-cronjob-v1beta1-batch","watch-list-cronjob-v1beta1-batch","watch-cronjob-v1beta1-batch","list-all-namespaces-cronjob-v1beta1-batch","list-cronjob-v1beta1-batch","read-cronjob-v1beta1-batch","-strong-read-operations-cronjob-v1beta1-batch-strong-","delete-collection-cronjob-v1beta1-batch","delete-cronjob-v1beta1-batch","replace-cronjob-v1beta1-batch","patch-cronjob-v1beta1-batch","create-cronjob-v1beta1-batch","-strong-write-operations-cronjob-v1beta1-batch-strong-","cronjob-v1beta1-batch","containerresourcemetricstatus-v2beta1-autoscaling","containerresourcemetricsource-v2beta1-autoscaling","watch-list-clusterrolebinding-v1alpha1-rbac-authorization-k8s-io","watch-clusterrolebinding-v1alpha1-rbac-authorization-k8s-io","list-clusterrolebinding-v1alpha1-rbac-authorization-k8s-io","read-clusterrolebinding-v1alpha1-rbac-authorization-k8s-io","-strong-read-operations-clusterrolebinding-v1alpha1-rbac-authorization-k8s-io-strong-","delete-collection-clusterrolebinding-v1alpha1-rbac-authorization-k8s-io","delete-clusterrolebinding-v1alpha1-rbac-authorization-k8s-io","replace-clusterrolebinding-v1alpha1-rbac-authorization-k8s-io","patch-clusterrolebinding-v1alpha1-rbac-authorization-k8s-io","create-clusterrolebinding-v1alpha1-rbac-authorization-k8s-io","-strong-write-operations-clusterrolebinding-v1alpha1-rbac-authorization-k8s-io-strong-","clusterrolebinding-v1alpha1-rbac-authorization-k8s-io","watch-list-clusterrolebinding-v1beta1-rbac-authorization-k8s-io","watch-clusterrolebinding-v1beta1-rbac-authorization-k8s-io","list-clusterrolebinding-v1beta1-rbac-authorization-k8s-io","read-clusterrolebinding-v1beta1-rbac-authorization-k8s-io","-strong-read-operations-clusterrolebinding-v1beta1-rbac-authorization-k8s-io-strong-","delete-collection-clusterrolebinding-v1beta1-rbac-authorization-k8s-io","delete-clusterrolebinding-v1beta1-rbac-authorization-k8s-io","replace-clusterrolebinding-v1beta1-rbac-authorization-k8s-io","patch-clusterrolebinding-v1beta1-rbac-authorization-k8s-io","create-clusterrolebinding-v1beta1-rbac-authorization-k8s-io","-strong-write-operations-clusterrolebinding-v1beta1-rbac-authorization-k8s-io-strong-","clusterrolebinding-v1beta1-rbac-authorization-k8s-io","watch-list-clusterrole-v1alpha1-rbac-authorization-k8s-io","watch-clusterrole-v1alpha1-rbac-authorization-k8s-io","list-clusterrole-v1alpha1-rbac-authorization-k8s-io","read-clusterrole-v1alpha1-rbac-authorization-k8s-io","-strong-read-operations-clusterrole-v1alpha1-rbac-authorization-k8s-io-strong-","delete-collection-clusterrole-v1alpha1-rbac-authorization-k8s-io","delete-clusterrole-v1alpha1-rbac-authorization-k8s-io","replace-clusterrole-v1alpha1-rbac-authorization-k8s-io","patch-clusterrole-v1alpha1-rbac-authorization-k8s-io","create-clusterrole-v1alpha1-rbac-authorization-k8s-io","-strong-write-operations-clusterrole-v1alpha1-rbac-authorization-k8s-io-strong-","clusterrole-v1alpha1-rbac-authorization-k8s-io","watch-list-clusterrole-v1beta1-rbac-authorization-k8s-io","watch-clusterrole-v1beta1-rbac-authorization-k8s-io","list-clusterrole-v1beta1-rbac-authorization-k8s-io","read-clusterrole-v1beta1-rbac-authorization-k8s-io","-strong-read-operations-clusterrole-v1beta1-rbac-authorization-k8s-io-strong-","delete-collection-clusterrole-v1beta1-rbac-authorization-k8s-io","delete-clusterrole-v1beta1-rbac-authorization-k8s-io","replace-clusterrole-v1beta1-rbac-authorization-k8s-io","patch-clusterrole-v1beta1-rbac-authorization-k8s-io","create-clusterrole-v1beta1-rbac-authorization-k8s-io","-strong-write-operations-clusterrole-v1beta1-rbac-authorization-k8s-io-strong-","clusterrole-v1beta1-rbac-authorization-k8s-io","certificatesigningrequestcondition-v1beta1-certificates-k8s-io","replace-status-certificatesigningrequest-v1beta1-certificates-k8s-io","read-status-certificatesigningrequest-v1beta1-certificates-k8s-io","patch-status-certificatesigningrequest-v1beta1-certificates-k8s-io","-strong-status-operations-certificatesigningrequest-v1beta1-certificates-k8s-io-strong-","watch-list-certificatesigningrequest-v1beta1-certificates-k8s-io","watch-certificatesigningrequest-v1beta1-certificates-k8s-io","list-certificatesigningrequest-v1beta1-certificates-k8s-io","read-certificatesigningrequest-v1beta1-certificates-k8s-io","-strong-read-operations-certificatesigningrequest-v1beta1-certificates-k8s-io-strong-","delete-collection-certificatesigningrequest-v1beta1-certificates-k8s-io","delete-certificatesigningrequest-v1beta1-certificates-k8s-io","replace-certificatesigningrequest-v1beta1-certificates-k8s-io","patch-certificatesigningrequest-v1beta1-certificates-k8s-io","create-certificatesigningrequest-v1beta1-certificates-k8s-io","-strong-write-operations-certificatesigningrequest-v1beta1-certificates-k8s-io-strong-","certificatesigningrequest-v1beta1-certificates-k8s-io","watch-list-all-namespaces-csistoragecapacity-v1alpha1-storage-k8s-io","watch-list-csistoragecapacity-v1alpha1-storage-k8s-io","watch-csistoragecapacity-v1alpha1-storage-k8s-io","list-all-namespaces-csistoragecapacity-v1alpha1-storage-k8s-io","list-csistoragecapacity-v1alpha1-storage-k8s-io","read-csistoragecapacity-v1alpha1-storage-k8s-io","-strong-read-operations-csistoragecapacity-v1alpha1-storage-k8s-io-strong-","delete-collection-csistoragecapacity-v1alpha1-storage-k8s-io","delete-csistoragecapacity-v1alpha1-storage-k8s-io","replace-csistoragecapacity-v1alpha1-storage-k8s-io","patch-csistoragecapacity-v1alpha1-storage-k8s-io","create-csistoragecapacity-v1alpha1-storage-k8s-io","-strong-write-operations-csistoragecapacity-v1alpha1-storage-k8s-io-strong-","csistoragecapacity-v1alpha1-storage-k8s-io","csinodedriver-v1beta1-storage-k8s-io","watch-list-csinode-v1beta1-storage-k8s-io","watch-csinode-v1beta1-storage-k8s-io","list-csinode-v1beta1-storage-k8s-io","read-csinode-v1beta1-storage-k8s-io","-strong-read-operations-csinode-v1beta1-storage-k8s-io-strong-","delete-collection-csinode-v1beta1-storage-k8s-io","delete-csinode-v1beta1-storage-k8s-io","replace-csinode-v1beta1-storage-k8s-io","patch-csinode-v1beta1-storage-k8s-io","create-csinode-v1beta1-storage-k8s-io","-strong-write-operations-csinode-v1beta1-storage-k8s-io-strong-","csinode-v1beta1-storage-k8s-io","watch-list-csidriver-v1beta1-storage-k8s-io","watch-csidriver-v1beta1-storage-k8s-io","list-csidriver-v1beta1-storage-k8s-io","read-csidriver-v1beta1-storage-k8s-io","-strong-read-operations-csidriver-v1beta1-storage-k8s-io-strong-","delete-collection-csidriver-v1beta1-storage-k8s-io","delete-csidriver-v1beta1-storage-k8s-io","replace-csidriver-v1beta1-storage-k8s-io","patch-csidriver-v1beta1-storage-k8s-io","create-csidriver-v1beta1-storage-k8s-io","-strong-write-operations-csidriver-v1beta1-storage-k8s-io-strong-","csidriver-v1beta1-storage-k8s-io","aggregationrule-v1alpha1-rbac-authorization-k8s-io","aggregationrule-v1beta1-rbac-authorization-k8s-io","apiservicecondition-v1beta1-apiregistration-k8s-io","replace-status-apiservice-v1beta1-apiregistration-k8s-io","read-status-apiservice-v1beta1-apiregistration-k8s-io","patch-status-apiservice-v1beta1-apiregistration-k8s-io","-strong-status-operations-apiservice-v1beta1-apiregistration-k8s-io-strong-","watch-list-apiservice-v1beta1-apiregistration-k8s-io","watch-apiservice-v1beta1-apiregistration-k8s-io","list-apiservice-v1beta1-apiregistration-k8s-io","read-apiservice-v1beta1-apiregistration-k8s-io","-strong-read-operations-apiservice-v1beta1-apiregistration-k8s-io-strong-","delete-collection-apiservice-v1beta1-apiregistration-k8s-io","delete-apiservice-v1beta1-apiregistration-k8s-io","replace-apiservice-v1beta1-apiregistration-k8s-io","patch-apiservice-v1beta1-apiregistration-k8s-io","create-apiservice-v1beta1-apiregistration-k8s-io","-strong-write-operations-apiservice-v1beta1-apiregistration-k8s-io-strong-","apiservice-v1beta1-apiregistration-k8s-io","-strong-old-api-versions-strong-","windowssecuritycontextoptions-v1-core","weightedpodaffinityterm-v1-core","webhookconversion-v1-apiextensions-k8s-io","webhookclientconfig-v1-admissionregistration-k8s-io","watchevent-v1-meta","vspherevirtualdiskvolumesource-v1-core","volumeprojection-v1-core","volumenoderesources-v1-storage-k8s-io","volumenodeaffinity-v1-core","volumemount-v1-core","volumeerror-v1-storage-k8s-io","volumedevice-v1-core","volumeattachmentsource-v1-storage-k8s-io","validatingwebhook-v1-admissionregistration-k8s-io","usersubject-v1beta1-flowcontrol-apiserver-k8s-io","userinfo-v1-authentication-k8s-io","typedlocalobjectreference-v1-core","topologyspreadconstraint-v1-core","topologyselectorterm-v1-core","topologyselectorlabelrequirement-v1-core","toleration-v1-core","time-v1-meta","taint-v1-core","tcpsocketaction-v1-core","sysctl-v1-core","supplementalgroupsstrategyoptions-v1beta1-policy","subjectrulesreviewstatus-v1-authorization-k8s-io","subject-v1beta1-flowcontrol-apiserver-k8s-io","storageversioncondition-v1alpha1-internal-apiserver-k8s-io","storageosvolumesource-v1-core","storageospersistentvolumesource-v1-core","statusdetails-v1-meta","statuscause-v1-meta","status-v1-meta","statefulsetupdatestrategy-v1-apps","statefulsetcondition-v1-apps","sessionaffinityconfig-v1-core","servicereference-v1-admissionregistration-k8s-io","serviceport-v1-core","servicebackendport-v1-networking-k8s-io","serviceaccounttokenprojection-v1-core","serviceaccountsubject-v1beta1-flowcontrol-apiserver-k8s-io","serverstorageversion-v1alpha1-internal-apiserver-k8s-io","serveraddressbyclientcidr-v1-meta","securitycontext-v1-core","secretvolumesource-v1-core","secretreference-v1-core","secretprojection-v1-core","secretkeyselector-v1-core","secretenvsource-v1-core","seccompprofile-v1-core","scopedresourceselectorrequirement-v1-core","scopeselector-v1-core","scheduling-v1-node-k8s-io","scaleiovolumesource-v1-core","scaleiopersistentvolumesource-v1-core","scale-v1-autoscaling","selinuxstrategyoptions-v1beta1-policy","selinuxoptions-v1-core","runtimeclassstrategyoptions-v1beta1-policy","runasuserstrategyoptions-v1beta1-policy","runasgroupstrategyoptions-v1beta1-policy","rulewithoperations-v1-admissionregistration-k8s-io","rollingupdatestatefulsetstrategy-v1-apps","roleref-v1-rbac-authorization-k8s-io","resourcerule-v1-authorization-k8s-io","resourcerequirements-v1-core","resourcepolicyrule-v1beta1-flowcontrol-apiserver-k8s-io","resourcemetricstatus-v2beta2-autoscaling","resourcemetricsource-v2beta2-autoscaling","resourcefieldselector-v1-core","resourceattributes-v1-authorization-k8s-io","replicationcontrollercondition-v1-core","replicasetcondition-v1-apps","rbdvolumesource-v1-core","rbdpersistentvolumesource-v1-core","quobytevolumesource-v1-core","queuingconfiguration-v1beta1-flowcontrol-apiserver-k8s-io","quantity-resource-core","projectedvolumesource-v1-core","probe-v1-core","prioritylevelconfigurationreference-v1beta1-flowcontrol-apiserver-k8s-io","prioritylevelconfigurationcondition-v1beta1-flowcontrol-apiserver-k8s-io","preferredschedulingterm-v1-core","preconditions-v1-meta","portworxvolumesource-v1-core","portstatus-v1-core","policyruleswithsubjects-v1beta1-flowcontrol-apiserver-k8s-io","policyrule-v1-rbac-authorization-k8s-io","podsmetricstatus-v2beta2-autoscaling","podsmetricsource-v2beta2-autoscaling","podsecuritycontext-v1-core","podreadinessgate-v1-core","podip-v1-core","poddisruptionbudget-v1-policy","poddnsconfigoption-v1-core","poddnsconfig-v1-core","podcondition-v1-core","podantiaffinity-v1-core","podaffinityterm-v1-core","podaffinity-v1-core","photonpersistentdiskvolumesource-v1-core","persistentvolumeclaimvolumesource-v1-core","persistentvolumeclaimtemplate-v1-core","persistentvolumeclaimcondition-v1-core","patch-v1-meta","ownerreference-v1-meta","overhead-v1-node-k8s-io","objectreference-v1-core","objectmetricstatus-v2beta2-autoscaling","objectmetricsource-v2beta2-autoscaling","objectmeta-v1-meta","objectfieldselector-v1-core","nonresourcerule-v1-authorization-k8s-io","nonresourcepolicyrule-v1beta1-flowcontrol-apiserver-k8s-io","nonresourceattributes-v1-authorization-k8s-io","nodesysteminfo-v1-core","nodeselectorterm-v1-core","nodeselectorrequirement-v1-core","nodeselector-v1-core","nodedaemonendpoints-v1-core","nodeconfigstatus-v1-core","nodeconfigsource-v1-core","nodecondition-v1-core","nodeaffinity-v1-core","nodeaddress-v1-core","networkpolicyport-v1-networking-k8s-io","networkpolicypeer-v1-networking-k8s-io","networkpolicyingressrule-v1-networking-k8s-io","networkpolicyegressrule-v1-networking-k8s-io","namespacecondition-v1-core","nfsvolumesource-v1-core","mutatingwebhook-v1-admissionregistration-k8s-io","microtime-v1-meta","metricvaluestatus-v2beta2-autoscaling","metrictarget-v2beta2-autoscaling","metricstatus-v2beta2-autoscaling","metricspec-v2beta2-autoscaling","metricidentifier-v2beta2-autoscaling","managedfieldsentry-v1-meta","localvolumesource-v1-core","localobjectreference-v1-core","loadbalancerstatus-v1-core","loadbalanceringress-v1-core","listmeta-v1-meta","limitedprioritylevelconfiguration-v1beta1-flowcontrol-apiserver-k8s-io","limitresponse-v1beta1-flowcontrol-apiserver-k8s-io","limitrangeitem-v1-core","lifecycle-v1-core","labelselectorrequirement-v1-meta","labelselector-v1-meta","keytopath-v1-core","jobtemplatespec-v1-batch","jobcondition-v1-batch","jsonschemapropsorbool-v1-apiextensions-k8s-io","jsonschemapropsorarray-v1-apiextensions-k8s-io","jsonschemaprops-v1-apiextensions-k8s-io","json-v1-apiextensions-k8s-io","ingresstls-v1-networking-k8s-io","ingressservicebackend-v1-networking-k8s-io","ingressrule-v1-networking-k8s-io","ingressclassparametersreference-v1-networking-k8s-io","ingressbackend-v1-networking-k8s-io","iscsivolumesource-v1-core","iscsipersistentvolumesource-v1-core","ipblock-v1-networking-k8s-io","idrange-v1beta1-policy","hostportrange-v1beta1-policy","hostpathvolumesource-v1-core","hostalias-v1-core","horizontalpodautoscalercondition-v2beta2-autoscaling","horizontalpodautoscalerbehavior-v2beta2-autoscaling","handler-v1-core","httpingressrulevalue-v1-networking-k8s-io","httpingresspath-v1-networking-k8s-io","httpheader-v1-core","httpgetaction-v1-core","hpascalingrules-v2beta2-autoscaling","hpascalingpolicy-v2beta2-autoscaling","groupversionfordiscovery-v1-meta","groupsubject-v1beta1-flowcontrol-apiserver-k8s-io","glusterfsvolumesource-v1-core","glusterfspersistentvolumesource-v1-core","gitrepovolumesource-v1-core","gcepersistentdiskvolumesource-v1-core","forzone-v1-discovery-k8s-io","flowschemacondition-v1beta1-flowcontrol-apiserver-k8s-io","flowdistinguishermethod-v1beta1-flowcontrol-apiserver-k8s-io","flockervolumesource-v1-core","flexvolumesource-v1-core","flexpersistentvolumesource-v1-core","fieldsv1-v1-meta","fsgroupstrategyoptions-v1beta1-policy","fcvolumesource-v1-core","externalmetricstatus-v2beta2-autoscaling","externalmetricsource-v2beta2-autoscaling","externaldocumentation-v1-apiextensions-k8s-io","execaction-v1-core","eviction-v1beta1-policy","eventsource-v1-core","eventseries-v1-core","ephemeralvolumesource-v1-core","ephemeralcontainers-v1-core","ephemeralcontainer-v1-core","envvarsource-v1-core","envvar-v1-core","envfromsource-v1-core","endpointsubset-v1-core","endpointslice-v1-discovery-k8s-io","endpointport-v1-core","endpointhints-v1-discovery-k8s-io","endpointconditions-v1-discovery-k8s-io","endpointaddress-v1-core","endpoint-v1-discovery-k8s-io","emptydirvolumesource-v1-core","downwardapivolumesource-v1-core","downwardapivolumefile-v1-core","downwardapiprojection-v1-core","deploymentcondition-v1-apps","deleteoptions-v1-meta","daemonsetupdatestrategy-v1-apps","daemonsetcondition-v1-apps","daemonendpoint-v1-core","customresourcevalidation-v1-apiextensions-k8s-io","customresourcesubresources-v1-apiextensions-k8s-io","customresourcesubresourcestatus-v1-apiextensions-k8s-io","customresourcesubresourcescale-v1-apiextensions-k8s-io","customresourcedefinitionversion-v1-apiextensions-k8s-io","customresourcedefinitionnames-v1-apiextensions-k8s-io","customresourcedefinitioncondition-v1-apiextensions-k8s-io","customresourceconversion-v1-apiextensions-k8s-io","customresourcecolumndefinition-v1-apiextensions-k8s-io","crossversionobjectreference-v1-autoscaling","cronjob-v1-batch","containerstatewaiting-v1-core","containerstateterminated-v1-core","containerstaterunning-v1-core","containerstate-v1-core","containerresourcemetricstatus-v2beta2-autoscaling","containerresourcemetricsource-v2beta2-autoscaling","containerport-v1-core","containerimage-v1-core","configmapvolumesource-v1-core","configmapprojection-v1-core","configmapnodeconfigsource-v1-core","configmapkeyselector-v1-core","configmapenvsource-v1-core","condition-v1-meta","componentcondition-v1-core","clientipconfig-v1-core","cindervolumesource-v1-core","cinderpersistentvolumesource-v1-core","certificatesigningrequestcondition-v1-certificates-k8s-io","cephfsvolumesource-v1-core","cephfspersistentvolumesource-v1-core","capabilities-v1-core","csivolumesource-v1-core","csistoragecapacity-v1beta1-storage-k8s-io","csipersistentvolumesource-v1-core","csinodedriver-v1-storage-k8s-io","boundobjectreference-v1-authentication-k8s-io","azurefilevolumesource-v1-core","azurefilepersistentvolumesource-v1-core","azurediskvolumesource-v1-core","attachedvolume-v1-core","allowedhostpath-v1beta1-policy","allowedflexvolume-v1beta1-policy","allowedcsidriver-v1beta1-policy","aggregationrule-v1-rbac-authorization-k8s-io","affinity-v1-core","awselasticblockstorevolumesource-v1-core","apiversions-v1-meta","apiservicecondition-v1-apiregistration-k8s-io","apiresource-v1-meta","apigroup-v1-meta","-strong-definitions-strong-","watch-list-all-namespaces-networkpolicy-v1-networking-k8s-io","watch-list-networkpolicy-v1-networking-k8s-io","watch-networkpolicy-v1-networking-k8s-io","list-all-namespaces-networkpolicy-v1-networking-k8s-io","list-networkpolicy-v1-networking-k8s-io","read-networkpolicy-v1-networking-k8s-io","-strong-read-operations-networkpolicy-v1-networking-k8s-io-strong-","delete-collection-networkpolicy-v1-networking-k8s-io","delete-networkpolicy-v1-networking-k8s-io","replace-networkpolicy-v1-networking-k8s-io","patch-networkpolicy-v1-networking-k8s-io","create-networkpolicy-v1-networking-k8s-io","-strong-write-operations-networkpolicy-v1-networking-k8s-io-strong-","networkpolicy-v1-networking-k8s-io","create-tokenreview-v1-authentication-k8s-io","-strong-write-operations-tokenreview-v1-authentication-k8s-io-strong-","tokenreview-v1-authentication-k8s-io","tokenrequest-v1-authentication-k8s-io","create-subjectaccessreview-v1-authorization-k8s-io","-strong-write-operations-subjectaccessreview-v1-authorization-k8s-io-strong-","subjectaccessreview-v1-authorization-k8s-io","replace-status-storageversion-v1alpha1-internal-apiserver-k8s-io","read-status-storageversion-v1alpha1-internal-apiserver-k8s-io","patch-status-storageversion-v1alpha1-internal-apiserver-k8s-io","-strong-status-operations-storageversion-v1alpha1-internal-apiserver-k8s-io-strong-","watch-list-storageversion-v1alpha1-internal-apiserver-k8s-io","watch-storageversion-v1alpha1-internal-apiserver-k8s-io","list-storageversion-v1alpha1-internal-apiserver-k8s-io","read-storageversion-v1alpha1-internal-apiserver-k8s-io","-strong-read-operations-storageversion-v1alpha1-internal-apiserver-k8s-io-strong-","delete-collection-storageversion-v1alpha1-internal-apiserver-k8s-io","delete-storageversion-v1alpha1-internal-apiserver-k8s-io","replace-storageversion-v1alpha1-internal-apiserver-k8s-io","patch-storageversion-v1alpha1-internal-apiserver-k8s-io","create-storageversion-v1alpha1-internal-apiserver-k8s-io","-strong-write-operations-storageversion-v1alpha1-internal-apiserver-k8s-io-strong-","storageversion-v1alpha1-internal-apiserver-k8s-io","watch-list-all-namespaces-serviceaccount-v1-core","watch-list-serviceaccount-v1-core","watch-serviceaccount-v1-core","list-all-namespaces-serviceaccount-v1-core","list-serviceaccount-v1-core","read-serviceaccount-v1-core","-strong-read-operations-serviceaccount-v1-core-strong-","delete-collection-serviceaccount-v1-core","delete-serviceaccount-v1-core","replace-serviceaccount-v1-core","patch-serviceaccount-v1-core","create-serviceaccount-v1-core","-strong-write-operations-serviceaccount-v1-core-strong-","serviceaccount-v1-core","create-selfsubjectrulesreview-v1-authorization-k8s-io","-strong-write-operations-selfsubjectrulesreview-v1-authorization-k8s-io-strong-","selfsubjectrulesreview-v1-authorization-k8s-io","create-selfsubjectaccessreview-v1-authorization-k8s-io","-strong-write-operations-selfsubjectaccessreview-v1-authorization-k8s-io-strong-","selfsubjectaccessreview-v1-authorization-k8s-io","watch-list-runtimeclass-v1-node-k8s-io","watch-runtimeclass-v1-node-k8s-io","list-runtimeclass-v1-node-k8s-io","read-runtimeclass-v1-node-k8s-io","-strong-read-operations-runtimeclass-v1-node-k8s-io-strong-","delete-collection-runtimeclass-v1-node-k8s-io","delete-runtimeclass-v1-node-k8s-io","replace-runtimeclass-v1-node-k8s-io","patch-runtimeclass-v1-node-k8s-io","create-runtimeclass-v1-node-k8s-io","-strong-write-operations-runtimeclass-v1-node-k8s-io-strong-","runtimeclass-v1-node-k8s-io","watch-list-all-namespaces-rolebinding-v1-rbac-authorization-k8s-io","watch-list-rolebinding-v1-rbac-authorization-k8s-io","watch-rolebinding-v1-rbac-authorization-k8s-io","list-all-namespaces-rolebinding-v1-rbac-authorization-k8s-io","list-rolebinding-v1-rbac-authorization-k8s-io","read-rolebinding-v1-rbac-authorization-k8s-io","-strong-read-operations-rolebinding-v1-rbac-authorization-k8s-io-strong-","delete-collection-rolebinding-v1-rbac-authorization-k8s-io","delete-rolebinding-v1-rbac-authorization-k8s-io","replace-rolebinding-v1-rbac-authorization-k8s-io","patch-rolebinding-v1-rbac-authorization-k8s-io","create-rolebinding-v1-rbac-authorization-k8s-io","-strong-write-operations-rolebinding-v1-rbac-authorization-k8s-io-strong-","rolebinding-v1-rbac-authorization-k8s-io","watch-list-all-namespaces-role-v1-rbac-authorization-k8s-io","watch-list-role-v1-rbac-authorization-k8s-io","watch-role-v1-rbac-authorization-k8s-io","list-all-namespaces-role-v1-rbac-authorization-k8s-io","list-role-v1-rbac-authorization-k8s-io","read-role-v1-rbac-authorization-k8s-io","-strong-read-operations-role-v1-rbac-authorization-k8s-io-strong-","delete-collection-role-v1-rbac-authorization-k8s-io","delete-role-v1-rbac-authorization-k8s-io","replace-role-v1-rbac-authorization-k8s-io","patch-role-v1-rbac-authorization-k8s-io","create-role-v1-rbac-authorization-k8s-io","-strong-write-operations-role-v1-rbac-authorization-k8s-io-strong-","role-v1-rbac-authorization-k8s-io","replace-status-resourcequota-v1-core","read-status-resourcequota-v1-core","patch-status-resourcequota-v1-core","-strong-status-operations-resourcequota-v1-core-strong-","watch-list-all-namespaces-resourcequota-v1-core","watch-list-resourcequota-v1-core","watch-resourcequota-v1-core","list-all-namespaces-resourcequota-v1-core","list-resourcequota-v1-core","read-resourcequota-v1-core","-strong-read-operations-resourcequota-v1-core-strong-","delete-collection-resourcequota-v1-core","delete-resourcequota-v1-core","replace-resourcequota-v1-core","patch-resourcequota-v1-core","create-resourcequota-v1-core","-strong-write-operations-resourcequota-v1-core-strong-","resourcequota-v1-core","replace-status-prioritylevelconfiguration-v1beta1-flowcontrol-apiserver-k8s-io","read-status-prioritylevelconfiguration-v1beta1-flowcontrol-apiserver-k8s-io","patch-status-prioritylevelconfiguration-v1beta1-flowcontrol-apiserver-k8s-io","-strong-status-operations-prioritylevelconfiguration-v1beta1-flowcontrol-apiserver-k8s-io-strong-","watch-list-prioritylevelconfiguration-v1beta1-flowcontrol-apiserver-k8s-io","watch-prioritylevelconfiguration-v1beta1-flowcontrol-apiserver-k8s-io","list-prioritylevelconfiguration-v1beta1-flowcontrol-apiserver-k8s-io","read-prioritylevelconfiguration-v1beta1-flowcontrol-apiserver-k8s-io","-strong-read-operations-prioritylevelconfiguration-v1beta1-flowcontrol-apiserver-k8s-io-strong-","delete-collection-prioritylevelconfiguration-v1beta1-flowcontrol-apiserver-k8s-io","delete-prioritylevelconfiguration-v1beta1-flowcontrol-apiserver-k8s-io","replace-prioritylevelconfiguration-v1beta1-flowcontrol-apiserver-k8s-io","patch-prioritylevelconfiguration-v1beta1-flowcontrol-apiserver-k8s-io","create-prioritylevelconfiguration-v1beta1-flowcontrol-apiserver-k8s-io","-strong-write-operations-prioritylevelconfiguration-v1beta1-flowcontrol-apiserver-k8s-io-strong-","prioritylevelconfiguration-v1beta1-flowcontrol-apiserver-k8s-io","replace-status-persistentvolume-v1-core","read-status-persistentvolume-v1-core","patch-status-persistentvolume-v1-core","-strong-status-operations-persistentvolume-v1-core-strong-","watch-list-persistentvolume-v1-core","watch-persistentvolume-v1-core","list-persistentvolume-v1-core","read-persistentvolume-v1-core","-strong-read-operations-persistentvolume-v1-core-strong-","delete-collection-persistentvolume-v1-core","delete-persistentvolume-v1-core","replace-persistentvolume-v1-core","patch-persistentvolume-v1-core","create-persistentvolume-v1-core","-strong-write-operations-persistentvolume-v1-core-strong-","persistentvolume-v1-core","replace-connect-proxy-path-node-v1-core","replace-connect-proxy-node-v1-core","head-connect-proxy-path-node-v1-core","head-connect-proxy-node-v1-core","get-connect-proxy-path-node-v1-core","get-connect-proxy-node-v1-core","delete-connect-proxy-path-node-v1-core","delete-connect-proxy-node-v1-core","create-connect-proxy-path-node-v1-core","create-connect-proxy-node-v1-core","-strong-proxy-operations-node-v1-core-strong-","replace-status-node-v1-core","read-status-node-v1-core","patch-status-node-v1-core","-strong-status-operations-node-v1-core-strong-","watch-list-node-v1-core","watch-node-v1-core","list-node-v1-core","read-node-v1-core","-strong-read-operations-node-v1-core-strong-","delete-collection-node-v1-core","delete-node-v1-core","replace-node-v1-core","patch-node-v1-core","create-node-v1-core","-strong-write-operations-node-v1-core-strong-","node-v1-core","replace-status-namespace-v1-core","read-status-namespace-v1-core","patch-status-namespace-v1-core","-strong-status-operations-namespace-v1-core-strong-","watch-list-namespace-v1-core","watch-namespace-v1-core","list-namespace-v1-core","read-namespace-v1-core","-strong-read-operations-namespace-v1-core-strong-","delete-namespace-v1-core","replace-namespace-v1-core","patch-namespace-v1-core","create-namespace-v1-core","-strong-write-operations-namespace-v1-core-strong-","namespace-v1-core","create-localsubjectaccessreview-v1-authorization-k8s-io","-strong-write-operations-localsubjectaccessreview-v1-authorization-k8s-io-strong-","localsubjectaccessreview-v1-authorization-k8s-io","watch-list-all-namespaces-lease-v1-coordination-k8s-io","watch-list-lease-v1-coordination-k8s-io","watch-lease-v1-coordination-k8s-io","list-all-namespaces-lease-v1-coordination-k8s-io","list-lease-v1-coordination-k8s-io","read-lease-v1-coordination-k8s-io","-strong-read-operations-lease-v1-coordination-k8s-io-strong-","delete-collection-lease-v1-coordination-k8s-io","delete-lease-v1-coordination-k8s-io","replace-lease-v1-coordination-k8s-io","patch-lease-v1-coordination-k8s-io","create-lease-v1-coordination-k8s-io","-strong-write-operations-lease-v1-coordination-k8s-io-strong-","lease-v1-coordination-k8s-io","replace-status-flowschema-v1beta1-flowcontrol-apiserver-k8s-io","read-status-flowschema-v1beta1-flowcontrol-apiserver-k8s-io","patch-status-flowschema-v1beta1-flowcontrol-apiserver-k8s-io","-strong-status-operations-flowschema-v1beta1-flowcontrol-apiserver-k8s-io-strong-","watch-list-flowschema-v1beta1-flowcontrol-apiserver-k8s-io","watch-flowschema-v1beta1-flowcontrol-apiserver-k8s-io","list-flowschema-v1beta1-flowcontrol-apiserver-k8s-io","read-flowschema-v1beta1-flowcontrol-apiserver-k8s-io","-strong-read-operations-flowschema-v1beta1-flowcontrol-apiserver-k8s-io-strong-","delete-collection-flowschema-v1beta1-flowcontrol-apiserver-k8s-io","delete-flowschema-v1beta1-flowcontrol-apiserver-k8s-io","replace-flowschema-v1beta1-flowcontrol-apiserver-k8s-io","patch-flowschema-v1beta1-flowcontrol-apiserver-k8s-io","create-flowschema-v1beta1-flowcontrol-apiserver-k8s-io","-strong-write-operations-flowschema-v1beta1-flowcontrol-apiserver-k8s-io-strong-","flowschema-v1beta1-flowcontrol-apiserver-k8s-io","list-componentstatus-v1-core","read-componentstatus-v1-core","-strong-read-operations-componentstatus-v1-core-strong-","componentstatus-v1-core","watch-list-clusterrolebinding-v1-rbac-authorization-k8s-io","watch-clusterrolebinding-v1-rbac-authorization-k8s-io","list-clusterrolebinding-v1-rbac-authorization-k8s-io","read-clusterrolebinding-v1-rbac-authorization-k8s-io","-strong-read-operations-clusterrolebinding-v1-rbac-authorization-k8s-io-strong-","delete-collection-clusterrolebinding-v1-rbac-authorization-k8s-io","delete-clusterrolebinding-v1-rbac-authorization-k8s-io","replace-clusterrolebinding-v1-rbac-authorization-k8s-io","patch-clusterrolebinding-v1-rbac-authorization-k8s-io","create-clusterrolebinding-v1-rbac-authorization-k8s-io","-strong-write-operations-clusterrolebinding-v1-rbac-authorization-k8s-io-strong-","clusterrolebinding-v1-rbac-authorization-k8s-io","watch-list-clusterrole-v1-rbac-authorization-k8s-io","watch-clusterrole-v1-rbac-authorization-k8s-io","list-clusterrole-v1-rbac-authorization-k8s-io","read-clusterrole-v1-rbac-authorization-k8s-io","-strong-read-operations-clusterrole-v1-rbac-authorization-k8s-io-strong-","delete-collection-clusterrole-v1-rbac-authorization-k8s-io","delete-clusterrole-v1-rbac-authorization-k8s-io","replace-clusterrole-v1-rbac-authorization-k8s-io","patch-clusterrole-v1-rbac-authorization-k8s-io","create-clusterrole-v1-rbac-authorization-k8s-io","-strong-write-operations-clusterrole-v1-rbac-authorization-k8s-io-strong-","clusterrole-v1-rbac-authorization-k8s-io","replace-status-certificatesigningrequest-v1-certificates-k8s-io","read-status-certificatesigningrequest-v1-certificates-k8s-io","patch-status-certificatesigningrequest-v1-certificates-k8s-io","-strong-status-operations-certificatesigningrequest-v1-certificates-k8s-io-strong-","watch-list-certificatesigningrequest-v1-certificates-k8s-io","watch-certificatesigningrequest-v1-certificates-k8s-io","list-certificatesigningrequest-v1-certificates-k8s-io","read-certificatesigningrequest-v1-certificates-k8s-io","-strong-read-operations-certificatesigningrequest-v1-certificates-k8s-io-strong-","delete-collection-certificatesigningrequest-v1-certificates-k8s-io","delete-certificatesigningrequest-v1-certificates-k8s-io","replace-certificatesigningrequest-v1-certificates-k8s-io","patch-certificatesigningrequest-v1-certificates-k8s-io","create-certificatesigningrequest-v1-certificates-k8s-io","-strong-write-operations-certificatesigningrequest-v1-certificates-k8s-io-strong-","certificatesigningrequest-v1-certificates-k8s-io","create-binding-v1-core","-strong-write-operations-binding-v1-core-strong-","binding-v1-core","replace-status-apiservice-v1-apiregistration-k8s-io","read-status-apiservice-v1-apiregistration-k8s-io","patch-status-apiservice-v1-apiregistration-k8s-io","-strong-status-operations-apiservice-v1-apiregistration-k8s-io-strong-","watch-list-apiservice-v1-apiregistration-k8s-io","watch-apiservice-v1-apiregistration-k8s-io","list-apiservice-v1-apiregistration-k8s-io","read-apiservice-v1-apiregistration-k8s-io","-strong-read-operations-apiservice-v1-apiregistration-k8s-io-strong-","delete-collection-apiservice-v1-apiregistration-k8s-io","delete-apiservice-v1-apiregistration-k8s-io","replace-apiservice-v1-apiregistration-k8s-io","patch-apiservice-v1-apiregistration-k8s-io","create-apiservice-v1-apiregistration-k8s-io","-strong-write-operations-apiservice-v1-apiregistration-k8s-io-strong-","apiservice-v1-apiregistration-k8s-io","-strong-cluster-apis-strong-","watch-list-podsecuritypolicy-v1beta1-policy","watch-podsecuritypolicy-v1beta1-policy","list-podsecuritypolicy-v1beta1-policy","read-podsecuritypolicy-v1beta1-policy","-strong-read-operations-podsecuritypolicy-v1beta1-policy-strong-","delete-collection-podsecuritypolicy-v1beta1-policy","delete-podsecuritypolicy-v1beta1-policy","replace-podsecuritypolicy-v1beta1-policy","patch-podsecuritypolicy-v1beta1-policy","create-podsecuritypolicy-v1beta1-policy","-strong-write-operations-podsecuritypolicy-v1beta1-policy-strong-","podsecuritypolicy-v1beta1-policy","watch-list-priorityclass-v1-scheduling-k8s-io","watch-priorityclass-v1-scheduling-k8s-io","list-priorityclass-v1-scheduling-k8s-io","read-priorityclass-v1-scheduling-k8s-io","-strong-read-operations-priorityclass-v1-scheduling-k8s-io-strong-","delete-collection-priorityclass-v1-scheduling-k8s-io","delete-priorityclass-v1-scheduling-k8s-io","replace-priorityclass-v1-scheduling-k8s-io","patch-priorityclass-v1-scheduling-k8s-io","create-priorityclass-v1-scheduling-k8s-io","-strong-write-operations-priorityclass-v1-scheduling-k8s-io-strong-","priorityclass-v1-scheduling-k8s-io","replace-status-poddisruptionbudget-v1beta1-policy","read-status-poddisruptionbudget-v1beta1-policy","patch-status-poddisruptionbudget-v1beta1-policy","-strong-status-operations-poddisruptionbudget-v1beta1-policy-strong-","watch-list-all-namespaces-poddisruptionbudget-v1beta1-policy","watch-list-poddisruptionbudget-v1beta1-policy","watch-poddisruptionbudget-v1beta1-policy","list-all-namespaces-poddisruptionbudget-v1beta1-policy","list-poddisruptionbudget-v1beta1-policy","read-poddisruptionbudget-v1beta1-policy","-strong-read-operations-poddisruptionbudget-v1beta1-policy-strong-","delete-collection-poddisruptionbudget-v1beta1-policy","delete-poddisruptionbudget-v1beta1-policy","replace-poddisruptionbudget-v1beta1-policy","patch-poddisruptionbudget-v1beta1-policy","create-poddisruptionbudget-v1beta1-policy","-strong-write-operations-poddisruptionbudget-v1beta1-policy-strong-","poddisruptionbudget-v1beta1-policy","watch-list-all-namespaces-podtemplate-v1-core","watch-list-podtemplate-v1-core","watch-podtemplate-v1-core","list-all-namespaces-podtemplate-v1-core","list-podtemplate-v1-core","read-podtemplate-v1-core","-strong-read-operations-podtemplate-v1-core-strong-","delete-collection-podtemplate-v1-core","delete-podtemplate-v1-core","replace-podtemplate-v1-core","patch-podtemplate-v1-core","create-podtemplate-v1-core","-strong-write-operations-podtemplate-v1-core-strong-","podtemplate-v1-core","watch-list-validatingwebhookconfiguration-v1-admissionregistration-k8s-io","watch-validatingwebhookconfiguration-v1-admissionregistration-k8s-io","list-validatingwebhookconfiguration-v1-admissionregistration-k8s-io","read-validatingwebhookconfiguration-v1-admissionregistration-k8s-io","-strong-read-operations-validatingwebhookconfiguration-v1-admissionregistration-k8s-io-strong-","delete-collection-validatingwebhookconfiguration-v1-admissionregistration-k8s-io","delete-validatingwebhookconfiguration-v1-admissionregistration-k8s-io","replace-validatingwebhookconfiguration-v1-admissionregistration-k8s-io","patch-validatingwebhookconfiguration-v1-admissionregistration-k8s-io","create-validatingwebhookconfiguration-v1-admissionregistration-k8s-io","-strong-write-operations-validatingwebhookconfiguration-v1-admissionregistration-k8s-io-strong-","validatingwebhookconfiguration-v1-admissionregistration-k8s-io","watch-list-mutatingwebhookconfiguration-v1-admissionregistration-k8s-io","watch-mutatingwebhookconfiguration-v1-admissionregistration-k8s-io","list-mutatingwebhookconfiguration-v1-admissionregistration-k8s-io","read-mutatingwebhookconfiguration-v1-admissionregistration-k8s-io","-strong-read-operations-mutatingwebhookconfiguration-v1-admissionregistration-k8s-io-strong-","delete-collection-mutatingwebhookconfiguration-v1-admissionregistration-k8s-io","delete-mutatingwebhookconfiguration-v1-admissionregistration-k8s-io","replace-mutatingwebhookconfiguration-v1-admissionregistration-k8s-io","patch-mutatingwebhookconfiguration-v1-admissionregistration-k8s-io","create-mutatingwebhookconfiguration-v1-admissionregistration-k8s-io","-strong-write-operations-mutatingwebhookconfiguration-v1-admissionregistration-k8s-io-strong-","mutatingwebhookconfiguration-v1-admissionregistration-k8s-io","replace-status-horizontalpodautoscaler-v1-autoscaling","read-status-horizontalpodautoscaler-v1-autoscaling","patch-status-horizontalpodautoscaler-v1-autoscaling","-strong-status-operations-horizontalpodautoscaler-v1-autoscaling-strong-","watch-list-all-namespaces-horizontalpodautoscaler-v1-autoscaling","watch-list-horizontalpodautoscaler-v1-autoscaling","watch-horizontalpodautoscaler-v1-autoscaling","list-all-namespaces-horizontalpodautoscaler-v1-autoscaling","list-horizontalpodautoscaler-v1-autoscaling","read-horizontalpodautoscaler-v1-autoscaling","-strong-read-operations-horizontalpodautoscaler-v1-autoscaling-strong-","delete-collection-horizontalpodautoscaler-v1-autoscaling","delete-horizontalpodautoscaler-v1-autoscaling","replace-horizontalpodautoscaler-v1-autoscaling","patch-horizontalpodautoscaler-v1-autoscaling","create-horizontalpodautoscaler-v1-autoscaling","-strong-write-operations-horizontalpodautoscaler-v1-autoscaling-strong-","horizontalpodautoscaler-v1-autoscaling","watch-list-all-namespaces-limitrange-v1-core","watch-list-limitrange-v1-core","watch-limitrange-v1-core","list-all-namespaces-limitrange-v1-core","list-limitrange-v1-core","read-limitrange-v1-core","-strong-read-operations-limitrange-v1-core-strong-","delete-collection-limitrange-v1-core","delete-limitrange-v1-core","replace-limitrange-v1-core","patch-limitrange-v1-core","create-limitrange-v1-core","-strong-write-operations-limitrange-v1-core-strong-","limitrange-v1-core","watch-list-all-namespaces-event-v1-core","watch-list-event-v1-core","watch-event-v1-core","list-all-namespaces-event-v1-core","list-event-v1-core","read-event-v1-core","-strong-read-operations-event-v1-core-strong-","delete-collection-event-v1-core","delete-event-v1-core","replace-event-v1-core","patch-event-v1-core","create-event-v1-core","-strong-write-operations-event-v1-core-strong-","event-v1-core","replace-status-customresourcedefinition-v1-apiextensions-k8s-io","read-status-customresourcedefinition-v1-apiextensions-k8s-io","patch-status-customresourcedefinition-v1-apiextensions-k8s-io","-strong-status-operations-customresourcedefinition-v1-apiextensions-k8s-io-strong-","watch-list-customresourcedefinition-v1-apiextensions-k8s-io","watch-customresourcedefinition-v1-apiextensions-k8s-io","list-customresourcedefinition-v1-apiextensions-k8s-io","read-customresourcedefinition-v1-apiextensions-k8s-io","-strong-read-operations-customresourcedefinition-v1-apiextensions-k8s-io-strong-","delete-collection-customresourcedefinition-v1-apiextensions-k8s-io","delete-customresourcedefinition-v1-apiextensions-k8s-io","replace-customresourcedefinition-v1-apiextensions-k8s-io","patch-customresourcedefinition-v1-apiextensions-k8s-io","create-customresourcedefinition-v1-apiextensions-k8s-io","-strong-write-operations-customresourcedefinition-v1-apiextensions-k8s-io-strong-","customresourcedefinition-v1-apiextensions-k8s-io","watch-list-all-namespaces-controllerrevision-v1-apps","watch-list-controllerrevision-v1-apps","watch-controllerrevision-v1-apps","list-all-namespaces-controllerrevision-v1-apps","list-controllerrevision-v1-apps","read-controllerrevision-v1-apps","-strong-read-operations-controllerrevision-v1-apps-strong-","delete-collection-controllerrevision-v1-apps","delete-controllerrevision-v1-apps","replace-controllerrevision-v1-apps","patch-controllerrevision-v1-apps","create-controllerrevision-v1-apps","-strong-write-operations-controllerrevision-v1-apps-strong-","controllerrevision-v1-apps","-strong-metadata-apis-strong-","replace-status-volumeattachment-v1-storage-k8s-io","read-status-volumeattachment-v1-storage-k8s-io","patch-status-volumeattachment-v1-storage-k8s-io","-strong-status-operations-volumeattachment-v1-storage-k8s-io-strong-","watch-list-volumeattachment-v1-storage-k8s-io","watch-volumeattachment-v1-storage-k8s-io","list-volumeattachment-v1-storage-k8s-io","read-volumeattachment-v1-storage-k8s-io","-strong-read-operations-volumeattachment-v1-storage-k8s-io-strong-","delete-collection-volumeattachment-v1-storage-k8s-io","delete-volumeattachment-v1-storage-k8s-io","replace-volumeattachment-v1-storage-k8s-io","patch-volumeattachment-v1-storage-k8s-io","create-volumeattachment-v1-storage-k8s-io","-strong-write-operations-volumeattachment-v1-storage-k8s-io-strong-","volumeattachment-v1-storage-k8s-io","volume-v1-core","watch-list-storageclass-v1-storage-k8s-io","watch-storageclass-v1-storage-k8s-io","list-storageclass-v1-storage-k8s-io","read-storageclass-v1-storage-k8s-io","-strong-read-operations-storageclass-v1-storage-k8s-io-strong-","delete-collection-storageclass-v1-storage-k8s-io","delete-storageclass-v1-storage-k8s-io","replace-storageclass-v1-storage-k8s-io","patch-storageclass-v1-storage-k8s-io","create-storageclass-v1-storage-k8s-io","-strong-write-operations-storageclass-v1-storage-k8s-io-strong-","storageclass-v1-storage-k8s-io","replace-status-persistentvolumeclaim-v1-core","read-status-persistentvolumeclaim-v1-core","patch-status-persistentvolumeclaim-v1-core","-strong-status-operations-persistentvolumeclaim-v1-core-strong-","watch-list-all-namespaces-persistentvolumeclaim-v1-core","watch-list-persistentvolumeclaim-v1-core","watch-persistentvolumeclaim-v1-core","list-all-namespaces-persistentvolumeclaim-v1-core","list-persistentvolumeclaim-v1-core","read-persistentvolumeclaim-v1-core","-strong-read-operations-persistentvolumeclaim-v1-core-strong-","delete-collection-persistentvolumeclaim-v1-core","delete-persistentvolumeclaim-v1-core","replace-persistentvolumeclaim-v1-core","patch-persistentvolumeclaim-v1-core","create-persistentvolumeclaim-v1-core","-strong-write-operations-persistentvolumeclaim-v1-core-strong-","persistentvolumeclaim-v1-core","watch-list-all-namespaces-secret-v1-core","watch-list-secret-v1-core","watch-secret-v1-core","list-all-namespaces-secret-v1-core","list-secret-v1-core","read-secret-v1-core","-strong-read-operations-secret-v1-core-strong-","delete-collection-secret-v1-core","delete-secret-v1-core","replace-secret-v1-core","patch-secret-v1-core","create-secret-v1-core","-strong-write-operations-secret-v1-core-strong-","secret-v1-core","watch-list-csinode-v1-storage-k8s-io","watch-csinode-v1-storage-k8s-io","list-csinode-v1-storage-k8s-io","read-csinode-v1-storage-k8s-io","-strong-read-operations-csinode-v1-storage-k8s-io-strong-","delete-collection-csinode-v1-storage-k8s-io","delete-csinode-v1-storage-k8s-io","replace-csinode-v1-storage-k8s-io","patch-csinode-v1-storage-k8s-io","create-csinode-v1-storage-k8s-io","-strong-write-operations-csinode-v1-storage-k8s-io-strong-","csinode-v1-storage-k8s-io","watch-list-csidriver-v1-storage-k8s-io","watch-csidriver-v1-storage-k8s-io","list-csidriver-v1-storage-k8s-io","read-csidriver-v1-storage-k8s-io","-strong-read-operations-csidriver-v1-storage-k8s-io-strong-","delete-collection-csidriver-v1-storage-k8s-io","delete-csidriver-v1-storage-k8s-io","replace-csidriver-v1-storage-k8s-io","patch-csidriver-v1-storage-k8s-io","create-csidriver-v1-storage-k8s-io","-strong-write-operations-csidriver-v1-storage-k8s-io-strong-","csidriver-v1-storage-k8s-io","watch-list-all-namespaces-configmap-v1-core","watch-list-configmap-v1-core","watch-configmap-v1-core","list-all-namespaces-configmap-v1-core","list-configmap-v1-core","read-configmap-v1-core","-strong-read-operations-configmap-v1-core-strong-","delete-collection-configmap-v1-core","delete-configmap-v1-core","replace-configmap-v1-core","patch-configmap-v1-core","create-configmap-v1-core","-strong-write-operations-configmap-v1-core-strong-","configmap-v1-core","-strong-config-and-storage-apis-strong-","replace-connect-proxy-path-service-v1-core","replace-connect-proxy-service-v1-core","head-connect-proxy-path-service-v1-core","head-connect-proxy-service-v1-core","get-connect-proxy-path-service-v1-core","get-connect-proxy-service-v1-core","delete-connect-proxy-path-service-v1-core","delete-connect-proxy-service-v1-core","create-connect-proxy-path-service-v1-core","create-connect-proxy-service-v1-core","-strong-proxy-operations-service-v1-core-strong-","replace-status-service-v1-core","read-status-service-v1-core","patch-status-service-v1-core","-strong-status-operations-service-v1-core-strong-","watch-list-all-namespaces-service-v1-core","watch-list-service-v1-core","watch-service-v1-core","list-all-namespaces-service-v1-core","list-service-v1-core","read-service-v1-core","-strong-read-operations-service-v1-core-strong-","delete-service-v1-core","replace-service-v1-core","patch-service-v1-core","create-service-v1-core","-strong-write-operations-service-v1-core-strong-","service-v1-core","watch-list-ingressclass-v1-networking-k8s-io","watch-ingressclass-v1-networking-k8s-io","list-ingressclass-v1-networking-k8s-io","read-ingressclass-v1-networking-k8s-io","-strong-read-operations-ingressclass-v1-networking-k8s-io-strong-","delete-collection-ingressclass-v1-networking-k8s-io","delete-ingressclass-v1-networking-k8s-io","replace-ingressclass-v1-networking-k8s-io","patch-ingressclass-v1-networking-k8s-io","create-ingressclass-v1-networking-k8s-io","-strong-write-operations-ingressclass-v1-networking-k8s-io-strong-","ingressclass-v1-networking-k8s-io","replace-status-ingress-v1-networking-k8s-io","read-status-ingress-v1-networking-k8s-io","patch-status-ingress-v1-networking-k8s-io","-strong-status-operations-ingress-v1-networking-k8s-io-strong-","watch-list-all-namespaces-ingress-v1-networking-k8s-io","watch-list-ingress-v1-networking-k8s-io","watch-ingress-v1-networking-k8s-io","list-all-namespaces-ingress-v1-networking-k8s-io","list-ingress-v1-networking-k8s-io","read-ingress-v1-networking-k8s-io","-strong-read-operations-ingress-v1-networking-k8s-io-strong-","delete-collection-ingress-v1-networking-k8s-io","delete-ingress-v1-networking-k8s-io","replace-ingress-v1-networking-k8s-io","patch-ingress-v1-networking-k8s-io","create-ingress-v1-networking-k8s-io","-strong-write-operations-ingress-v1-networking-k8s-io-strong-","ingress-v1-networking-k8s-io","watch-list-all-namespaces-endpointslice-v1beta1-discovery-k8s-io","watch-list-endpointslice-v1beta1-discovery-k8s-io","watch-endpointslice-v1beta1-discovery-k8s-io","list-all-namespaces-endpointslice-v1beta1-discovery-k8s-io","list-endpointslice-v1beta1-discovery-k8s-io","read-endpointslice-v1beta1-discovery-k8s-io","-strong-read-operations-endpointslice-v1beta1-discovery-k8s-io-strong-","delete-collection-endpointslice-v1beta1-discovery-k8s-io","delete-endpointslice-v1beta1-discovery-k8s-io","replace-endpointslice-v1beta1-discovery-k8s-io","patch-endpointslice-v1beta1-discovery-k8s-io","create-endpointslice-v1beta1-discovery-k8s-io","-strong-write-operations-endpointslice-v1beta1-discovery-k8s-io-strong-","endpointslice-v1beta1-discovery-k8s-io","watch-list-all-namespaces-endpoints-v1-core","watch-list-endpoints-v1-core","watch-endpoints-v1-core","list-all-namespaces-endpoints-v1-core","list-endpoints-v1-core","read-endpoints-v1-core","-strong-read-operations-endpoints-v1-core-strong-","delete-collection-endpoints-v1-core","delete-endpoints-v1-core","replace-endpoints-v1-core","patch-endpoints-v1-core","create-endpoints-v1-core","-strong-write-operations-endpoints-v1-core-strong-","endpoints-v1-core","-strong-service-apis-strong-","patch-scale-statefulset-v1-apps","replace-scale-statefulset-v1-apps","read-scale-statefulset-v1-apps","-strong-misc-operations-statefulset-v1-apps-strong-","replace-status-statefulset-v1-apps","read-status-statefulset-v1-apps","patch-status-statefulset-v1-apps","-strong-status-operations-statefulset-v1-apps-strong-","watch-list-all-namespaces-statefulset-v1-apps","watch-list-statefulset-v1-apps","watch-statefulset-v1-apps","list-all-namespaces-statefulset-v1-apps","list-statefulset-v1-apps","read-statefulset-v1-apps","-strong-read-operations-statefulset-v1-apps-strong-","delete-collection-statefulset-v1-apps","delete-statefulset-v1-apps","replace-statefulset-v1-apps","patch-statefulset-v1-apps","create-statefulset-v1-apps","-strong-write-operations-statefulset-v1-apps-strong-","statefulset-v1-apps","patch-scale-replicationcontroller-v1-core","replace-scale-replicationcontroller-v1-core","read-scale-replicationcontroller-v1-core","-strong-misc-operations-replicationcontroller-v1-core-strong-","replace-status-replicationcontroller-v1-core","read-status-replicationcontroller-v1-core","patch-status-replicationcontroller-v1-core","-strong-status-operations-replicationcontroller-v1-core-strong-","watch-list-all-namespaces-replicationcontroller-v1-core","watch-list-replicationcontroller-v1-core","watch-replicationcontroller-v1-core","list-all-namespaces-replicationcontroller-v1-core","list-replicationcontroller-v1-core","read-replicationcontroller-v1-core","-strong-read-operations-replicationcontroller-v1-core-strong-","delete-collection-replicationcontroller-v1-core","delete-replicationcontroller-v1-core","replace-replicationcontroller-v1-core","patch-replicationcontroller-v1-core","create-replicationcontroller-v1-core","-strong-write-operations-replicationcontroller-v1-core-strong-","replicationcontroller-v1-core","patch-scale-replicaset-v1-apps","replace-scale-replicaset-v1-apps","read-scale-replicaset-v1-apps","-strong-misc-operations-replicaset-v1-apps-strong-","replace-status-replicaset-v1-apps","read-status-replicaset-v1-apps","patch-status-replicaset-v1-apps","-strong-status-operations-replicaset-v1-apps-strong-","watch-list-all-namespaces-replicaset-v1-apps","watch-list-replicaset-v1-apps","watch-replicaset-v1-apps","list-all-namespaces-replicaset-v1-apps","list-replicaset-v1-apps","read-replicaset-v1-apps","-strong-read-operations-replicaset-v1-apps-strong-","delete-collection-replicaset-v1-apps","delete-replicaset-v1-apps","replace-replicaset-v1-apps","patch-replicaset-v1-apps","create-replicaset-v1-apps","-strong-write-operations-replicaset-v1-apps-strong-","replicaset-v1-apps","read-log-pod-v1-core","-strong-misc-operations-pod-v1-core-strong-","replace-connect-proxy-path-pod-v1-core","replace-connect-proxy-pod-v1-core","head-connect-proxy-path-pod-v1-core","head-connect-proxy-pod-v1-core","get-connect-proxy-path-pod-v1-core","get-connect-proxy-pod-v1-core","get-connect-portforward-pod-v1-core","delete-connect-proxy-path-pod-v1-core","delete-connect-proxy-pod-v1-core","create-connect-proxy-path-pod-v1-core","create-connect-proxy-pod-v1-core","create-connect-portforward-pod-v1-core","-strong-proxy-operations-pod-v1-core-strong-","replace-status-pod-v1-core","read-status-pod-v1-core","patch-status-pod-v1-core","-strong-status-operations-pod-v1-core-strong-","watch-list-all-namespaces-pod-v1-core","watch-list-pod-v1-core","watch-pod-v1-core","list-all-namespaces-pod-v1-core","list-pod-v1-core","read-pod-v1-core","-strong-read-operations-pod-v1-core-strong-","delete-collection-pod-v1-core","delete-pod-v1-core","replace-pod-v1-core","patch-pod-v1-core","create-eviction-pod-v1-core","create-pod-v1-core","-strong-write-operations-pod-v1-core-strong-","pod-v1-core","replace-status-job-v1-batch","read-status-job-v1-batch","patch-status-job-v1-batch","-strong-status-operations-job-v1-batch-strong-","watch-list-all-namespaces-job-v1-batch","watch-list-job-v1-batch","watch-job-v1-batch","list-all-namespaces-job-v1-batch","list-job-v1-batch","read-job-v1-batch","-strong-read-operations-job-v1-batch-strong-","delete-collection-job-v1-batch","delete-job-v1-batch","replace-job-v1-batch","patch-job-v1-batch","create-job-v1-batch","-strong-write-operations-job-v1-batch-strong-","job-v1-batch","patch-scale-deployment-v1-apps","replace-scale-deployment-v1-apps","read-scale-deployment-v1-apps","-strong-misc-operations-deployment-v1-apps-strong-","replace-status-deployment-v1-apps","read-status-deployment-v1-apps","patch-status-deployment-v1-apps","-strong-status-operations-deployment-v1-apps-strong-","watch-list-all-namespaces-deployment-v1-apps","watch-list-deployment-v1-apps","watch-deployment-v1-apps","list-all-namespaces-deployment-v1-apps","list-deployment-v1-apps","read-deployment-v1-apps","-strong-read-operations-deployment-v1-apps-strong-","delete-collection-deployment-v1-apps","delete-deployment-v1-apps","replace-deployment-v1-apps","patch-deployment-v1-apps","create-deployment-v1-apps","-strong-write-operations-deployment-v1-apps-strong-","deployment-v1-apps","replace-status-daemonset-v1-apps","read-status-daemonset-v1-apps","patch-status-daemonset-v1-apps","-strong-status-operations-daemonset-v1-apps-strong-","watch-list-all-namespaces-daemonset-v1-apps","watch-list-daemonset-v1-apps","watch-daemonset-v1-apps","list-all-namespaces-daemonset-v1-apps","list-daemonset-v1-apps","read-daemonset-v1-apps","-strong-read-operations-daemonset-v1-apps-strong-","delete-collection-daemonset-v1-apps","delete-daemonset-v1-apps","replace-daemonset-v1-apps","patch-daemonset-v1-apps","create-daemonset-v1-apps","-strong-write-operations-daemonset-v1-apps-strong-","daemonset-v1-apps","replace-status-cronjob-v1beta1-batch","read-status-cronjob-v1beta1-batch","patch-status-cronjob-v1beta1-batch","-strong-status-operations-cronjob-v1beta1-batch-strong-","watch-list-all-namespaces-cronjob-v1beta1-batch","watch-list-cronjob-v1beta1-batch","watch-cronjob-v1beta1-batch","list-all-namespaces-cronjob-v1beta1-batch","list-cronjob-v1beta1-batch","read-cronjob-v1beta1-batch","-strong-read-operations-cronjob-v1beta1-batch-strong-","delete-collection-cronjob-v1beta1-batch","delete-cronjob-v1beta1-batch","replace-cronjob-v1beta1-batch","patch-cronjob-v1beta1-batch","create-cronjob-v1beta1-batch","-strong-write-operations-cronjob-v1beta1-batch-strong-","cronjob-v1beta1-batch","container-v1-core","-strong-workloads-apis-strong-","-strong-api-groups-strong-","-strong-api-overview-strong-"]};})(); \ No newline at end of file From 34f1d61c60dbe2bfbc23288f38670361b0343b3f Mon Sep 17 00:00:00 2001 From: Nick Santos Date: Fri, 2 Apr 2021 14:20:37 -0400 Subject: [PATCH 097/104] Fixed errors in instructions for generating ref docs Some minor mistakes I noticed: - WEB_ROOT is actually K8S_WEBROOT (https://github.com/kubernetes-sigs/reference-docs/blob/master/Makefile#L12) - copysrc puts the code in gen-apidocs/build, not gen-apidocs/generators/build (https://github.com/kubernetes-sigs/reference-docs/blob/master/Makefile#L89) - K8S_VERSION must have a patch number, because all kubernetes tags have patch numbers (https://github.com/kubernetes/kubernetes/tree/v1.17 vs https://github.com/kubernetes/kubernetes/tree/v1.17.0) --- .../contribute/generate-ref-docs/kubernetes-api.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/content/en/docs/contribute/generate-ref-docs/kubernetes-api.md b/content/en/docs/contribute/generate-ref-docs/kubernetes-api.md index 251dfe2efe..acc55b2807 100644 --- a/content/en/docs/contribute/generate-ref-docs/kubernetes-api.md +++ b/content/en/docs/contribute/generate-ref-docs/kubernetes-api.md @@ -83,16 +83,16 @@ This section shows how to generate the ### Setting build variables * Set `K8S_ROOT` to ``. -* Set `WEB_ROOT` to ``. +* Set `K8S_WEBROOT` to ``. * Set `K8S_RELEASE` to the version of the docs you want to build. - For example, if you want to build docs for Kubernetes 1.17, set `K8S_RELEASE` to 1.17. + For example, if you want to build docs for Kubernetes 1.17.0, set `K8S_RELEASE` to 1.17.0. For example: ```shell -export WEB_ROOT=$(GOPATH)/src/github.com//website +export K8S_WEBROOT=$(GOPATH)/src/github.com//website export K8S_ROOT=$(GOPATH)/src/k8s.io/kubernetes -export K8S_RELEASE=1.17 +export K8S_RELEASE=1.17.0 ``` ### Creating versioned directory and fetching Open API spec @@ -124,8 +124,8 @@ make copyapi Verify that these two files have been generated: ```shell -[ -e "/gen-apidocs/generators/build/index.html" ] && echo "index.html built" || echo "no index.html" -[ -e "/gen-apidocs/generators/build/navData.js" ] && echo "navData.js built" || echo "no navData.js" +[ -e "/gen-apidocs/build/index.html" ] && echo "index.html built" || echo "no index.html" +[ -e "/gen-apidocs/build/navData.js" ] && echo "navData.js built" || echo "no navData.js" ``` Go to the base of your local ``, and From 9717c5bb3be247a7c1d40ef46e923c40d1d085b4 Mon Sep 17 00:00:00 2001 From: carol valencia Date: Fri, 2 Apr 2021 12:28:52 -0300 Subject: [PATCH 098/104] chore: raelga review --- content/es/docs/concepts/security/overview.md | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/content/es/docs/concepts/security/overview.md b/content/es/docs/concepts/security/overview.md index f61b99c242..3a6d3cda9c 100644 --- a/content/es/docs/concepts/security/overview.md +++ b/content/es/docs/concepts/security/overview.md @@ -16,8 +16,8 @@ Este modelo de seguridad en el contenedor brinda sugerencias, no es una prueba d ## Las 4C de Seguridad en Cloud Native -Puede pensar en seguridad por capas. Las 4C de la seguridad en Cloud Native son la nube(Cloud), -Clústeres, Contenedores y Código. +Puede pensar en seguridad por capas. Las 4C de la seguridad en Cloud Native son la nube (Cloud), +{{< glossary_tooltip text="Clústeres" term_id="cluster" >}}, {{< glossary_tooltip text="Contenedores" term_id="container" >}} y Código. {{< note >}} Este enfoque en capas aumenta la [defensa en profundidad](https://en.wikipedia.org/wiki/Defense_in_depth_(computing)) @@ -27,10 +27,10 @@ de la seguridad, es considerada una buena práctica en seguridad para el softwar {{< figure src="/images/docs/4c.png" title="Las 4C de Seguridad en Cloud Native" >}} Cada capa del modelo de seguridad Cloud Native es basada en la siguiente capa más externa. -La capa de código se beneficia de una base sólida(nube, clúster, contenedor) de capas seguras. +La capa de código se beneficia de una base sólida (nube, clúster, contenedor) de capas seguras. No podemos garantizar la seguridad aplicando solo seguridad a nivel del código, y usar estándares de seguridad deficientes en las otras capas. -## Nube(Cloud) +## Nube (Cloud) En muchos sentidos, la nube (o los servidores o el centro de datos corporativo) es la [base de computador confiable](https://es.wikipedia.org/wiki/Base_de_computador_confiable) @@ -66,17 +66,17 @@ Sugerencias para proteger su infraestructura en un clúster de Kubernetes: Área de Interés para la Infraestructura de Kubernetes | Recomendación | --------------------------------------------- | -------------- | -Acceso de red al servidor API (Plano de Control) | Todo acceso público al plano de control del Kubernetes en Internet no está permitido y es controlado por listas de control de acceso a la red estrictas a un conjunto de direcciones IP necesarias para administrar el clúster.| -Acceso a la red de los Nodos | Los nodos deben ser configurados para _sólo_ aceptar conexiones (por medio de listas de control de acceso a la red) desde el plano de control en los puertos especificados y aceptar conexiones para servicios en Kubernetes del tipo NodePort y LoadBalancer. Si es posible, estos nodos no deben exponerse públicamente en Internet. +Acceso de red al Plano de Control | Todo acceso público al {{< glossary_tooltip text="plano de control" term_id="control-plane" >}} del Kubernetes en Internet no está permitido y es controlado por listas de control de acceso a la red estrictas a un conjunto de direcciones IP necesarias para administrar el clúster.| +Acceso a la red de los Nodos | Los {{< glossary_tooltip text="nodos" term_id="node" >}} deben ser configurados para _solo_ aceptar conexiones (por medio de listas de control de acceso a la red) desde el plano de control en los puertos especificados y aceptar conexiones para servicios en Kubernetes del tipo NodePort y LoadBalancer. Si es posible, estos nodos no deben exponerse públicamente en Internet. Acceso a la API de Kubernetes del proveedor de la nube | Cada proveedor de la nube debe dar un conjunto de permisos al plano de control y nodos del Kubernetes. Es mejor otorgar al clúster el permiso de acceso al proveedor de nube siguiendo el [principio de mínimo privilegio](https://es.wikipedia.org/wiki/Principio_de_m%C3%ADnimo_privilegio) para los recursos que necesite administrar. La [documentación del Kops](https://github.com/kubernetes/kops/blob/master/docs/iam_roles.md#iam-roles) ofrece información sobre las políticas y roles de IAM. -Acceso a etcd | El acceso a etcd (banco de datos de Kubernetes) debe ser limitado apenas al plano de control. Dependiendo de su configuración, debería intentar usar etcd sobre TLS. Puede encontrar mas información en la [documentación de etcd](https://github.com/etcd-io/etcd/tree/master/Documentation). -Encriptación etcd | Siempre que sea posible, es una buena práctica encriptar todas las unidades de almacenamiento, etcd mantiene el estado de todo el clúster (incluidos los Secretos), su disco debe estar encriptado. +Acceso a etcd | El acceso a {{< glossary_tooltip text="etcd" term_id="etcd" >}} (banco de datos de Kubernetes) debe ser limitado apenas al plano de control. Dependiendo de su configuración, debería intentar usar etcd sobre TLS. Puede encontrar mas información en la [documentación de etcd](https://github.com/etcd-io/etcd/tree/master/Documentation). +Encriptación etcd | Siempre que sea posible, es una buena práctica encriptar todas las unidades de almacenamiento. Etcd mantiene el estado de todo el clúster (incluidos los Secretos), por lo que su disco debe estar encriptado. {{< /table >}} ## Clúster -Existe dos áreas de preocupación para proteger Kubernetes: +Existen dos áreas de preocupación para proteger Kubernetes: * Protección de las configuraciones de los componentes del clúster. * Protección de las aplicaciones que se ejecutan en el clúster. @@ -92,7 +92,7 @@ buenas prácticas de seguridad, a continuación sigue estos consejos sobre Dependiendo de la superficie de ataque de su aplicación, es posible que desee concentrarse en temas de seguridad específicos. Por ejemplo: si está ejecutando un servicio (Servicio A) que es crítico en una cadena de otros recursos y otra carga de trabajo separada (Servicio B) que es -vulnerable a un ataque de sobrecarga de recursos y, en consecuencia, el riesgo de comprometer el Servicio A +vulnerable a un ataque de sobrecarga de recursos, el riesgo de comprometer el Servicio A es alto si no limita las funciones del Servicio B. La siguiente tabla enumera áreas de atención de seguridad y recomendaciones para proteger las cargas de trabajo que se ejecutan en Kubernetes: @@ -131,7 +131,7 @@ recomendaciones para proteger el código de su aplicación: Áreas de Atención para el Código | Recomendación | -------------------------| -------------- | Acceso solo a través de TLS | Si su código necesita comunicarse a través de TCP, ejecute un handshake TLS con el cliente anticipadamente. Con la excepción de algunos casos, encripte todo lo que está en tránsito. Yendo un paso más allá, es una buena idea cifrar el tráfico de red entre los servicios. Esto se puede hacer a través del proceso de autenticación mutua o [mTLS](https://en.wikipedia.org/wiki/Mutual_authentication), que realiza una verificación bilateral de la comunicación a través de los certificados en los servicios. | -Limitación de intervalos de puertos de comunicación | Esta recomendación puede ser un poco evidente, pero siempre que sea posible, solo debe exponer los puertos de su servicio que son absolutamente esenciales para la comunicación o la recopilación de métricas. | +Limitación de rangos de puertos de comunicación | Esta recomendación puede ser un poco evidente, pero siempre que sea posible, solo debe exponer los puertos de su servicio que son absolutamente esenciales para la comunicación o la recopilación de métricas. | Seguridad en dependencia de terceros | Es una buena práctica comprobar periódicamente las bibliotecas de terceros de su aplicación en busca de vulnerabilidades de seguridad. Cada lenguaje de programación tiene una herramienta para realizar esta verificación de forma automática. | Análisis de código estático | La mayoría de los lenguajes proporcionan una forma de analizar el código en busca de prácticas de codificación potencialmente inseguras. Siempre que sea posible, debe automatizar los escaneos utilizando herramientas que puedan escanear las bases del código en busca de errores de seguridad comunes. Algunas de las herramientas se pueden encontrar en [OWASP Source Code Analysis Tools](https://owasp.org/www-community/Source_Code_Analysis_Tools). | Ataques de sondeo dinámico | Existen algunas herramientas automatizadas que puede ejecutar en su servicio para explorar algunos de los ataques más conocidos. Esto incluye la inyección de SQL, CSRF y XSS. Una de las herramientas de análisis dinámico más populares es la [OWASP Zed Attack proxy](https://owasp.org/www-project-zap/). | @@ -146,7 +146,7 @@ Obtenga más información sobre los temas de seguridad de Kubernetes: * [Políticas de red para pods](/docs/concepts/services-networking/network-policies/) * [Control de acceso a la API de Kubernetes](/docs/concepts/security/controlling-access) * [Protegiendo su clúster](/docs/tasks/administer-cluster/securing-a-cluster/) -* [Criptografía de datos en tránsito](/docs/tasks/tls/managing-tls-in-a-cluster/) for the control plane +* [Criptografía de datos en tránsito](/docs/tasks/tls/managing-tls-in-a-cluster/) * [Criptografía de datos en reposo](/docs/tasks/administer-cluster/encrypt-data/) * [Secretos en Kubernetes](/docs/concepts/configuration/secret/) * [Runtime class](/docs/concepts/containers/runtime-class) \ No newline at end of file From 411f732ae31948a7400f22d5b500816e81869af3 Mon Sep 17 00:00:00 2001 From: Aris Cahyadi Risdianto Date: Sat, 3 Apr 2021 18:23:43 +0800 Subject: [PATCH 099/104] remove example task template to sync with upstream. --- .../id/docs/tasks/example-task-template.md | 54 ------------------- 1 file changed, 54 deletions(-) delete mode 100644 content/id/docs/tasks/example-task-template.md diff --git a/content/id/docs/tasks/example-task-template.md b/content/id/docs/tasks/example-task-template.md deleted file mode 100644 index a1873501f3..0000000000 --- a/content/id/docs/tasks/example-task-template.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: Contoh Template Tugas (Task) -content_type: task -toc_hide: true ---- - - - -{{< note >}} -Pastikan juga kamu [membuat isian di daftar isi](/docs/home/contribute/write-new-topic/#creating-an-entry-in-the-table-of-contents) untuk dokumen baru kamu. -{{< /note >}} - -Halaman ini menunjukkan bagaimana ... - - - -## {{% heading "prerequisites" %}} - - -* {{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} -* Lakukan ini. -* Lakukan ini juga. - - - - - -## Menjalankan ... - -1. Lakukan ini. -1. Selanjutnya lakukan ini. Bila mungkin silahkan baca [penjelasan terkait](...). - - - - - -## Memahami ... -**[Bagian opsional]** - -Berikut ini hal-hal yang menarik untuk diketahui tentang langkah-langkah yang baru saja kamu lakukan. - - - -## {{% heading "whatsnext" %}} - - -**[Bagian optional]** - -* Pelajari tentang [menulis topik baru](/docs/home/contribute/write-new-topic/). -* Lihat [menggunakan _template_ halaman - _template_ tugas](/docs/home/contribute/page-templates/#task_template) untuk mengetahui cara menggunakan _template_ ini. - - - - From be4091205788b4faef6e6883b3aa2737ba359f54 Mon Sep 17 00:00:00 2001 From: Aris Cahyadi Risdianto Date: Sat, 3 Apr 2021 19:05:47 +0800 Subject: [PATCH 100/104] remove cluster management to sync with upstream. --- .../docs/concepts/architecture/controller.md | 5 +- .../administer-cluster/cluster-management.md | 221 ------------------ static/_redirects | 1 + 3 files changed, 3 insertions(+), 224 deletions(-) delete mode 100644 content/id/docs/tasks/administer-cluster/cluster-management.md diff --git a/content/id/docs/concepts/architecture/controller.md b/content/id/docs/concepts/architecture/controller.md index 6cf90cf9e6..bff7130eb7 100644 --- a/content/id/docs/concepts/architecture/controller.md +++ b/content/id/docs/concepts/architecture/controller.md @@ -102,9 +102,8 @@ yang diinginkannya melalui server API, dan kemudian berkomunikasi langsung dengan sistem eksternal untuk membawa keadaan saat ini mendekat keadaan yang diinginkan. -(Sebenarnya ada sebuah _controller_ yang melakukan penskalaan node secara -horizontal dalam klaster kamu. Silahkan lihat -[_autoscaling_ klaster](/docs/tasks/administer-cluster/cluster-management/#cluster-autoscaling)). +(Sebenarnya ada sebuah [_controller_](https://github.com/kubernetes/autoscaler/) yang melakukan penskalaan node secara +horizontal dalam klaster kamu. ## Status sekarang berbanding status yang diinginkan {#sekarang-banding-diinginkan} diff --git a/content/id/docs/tasks/administer-cluster/cluster-management.md b/content/id/docs/tasks/administer-cluster/cluster-management.md deleted file mode 100644 index 0473dde9f3..0000000000 --- a/content/id/docs/tasks/administer-cluster/cluster-management.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -title: Manajemen Klaster -content_type: concept ---- - - - -Dokumen ini menjelaskan beberapa topik yang terkait dengan siklus hidup sebuah klaster: membuat klaster baru, -memperbarui Node _control plane_ dan Node pekerja dari klaster kamu, -melakukan pemeliharaan Node (misalnya pembaruan kernel), dan meningkatkan versi API Kubernetes dari -klaster yang berjalan. - - - - -## Membuat dan mengonfigurasi klaster - -Untuk menginstal Kubernetes dalam sekumpulan mesin, konsultasikan dengan salah satu [Panduan Memulai](/id/docs/setup) tergantung dengan lingkungan kamu. - -## Memperbarui klaster - -Status saat ini pembaruan klaster bergantung pada penyedia, dan beberapa rilis yang mungkin memerlukan perhatian khusus saat memperbaruinya. Direkomendasikan agar admin membaca [Catatan Rilis](https://git.k8s.io/kubernetes/CHANGELOG/README.md), serta catatan khusus pembaruan versi sebelum memperbarui klaster mereka. - -### Memperbarui klaster Azure Kubernetes Service (AKS) - -Azure Kubernetes Service memungkinkan pembaruan layanan mandiri yang mudah dari _control plane_ dan Node pada klaster kamu. Prosesnya adalah -saat ini dimulai oleh pengguna dan dijelaskan dalam [Azure AKS documentation](https://docs.microsoft.com/en-us/azure/aks/upgrade-cluster). - -### Memperbarui klaster Google Compute Engine - -Google Compute Engine Open Source (GCE-OSS) mendukung pembaruan _control plane_ dengan menghapus dan -membuat ulang _control plane_, sambil mempertahankan _Persistent Disk_ (PD) yang sama untuk memastikan bahwa data disimpan pada berkas -untuk setiap kali pembaruan. - -Pembaruan Node untuk GCE menggunakan [grup _instance_ yang di-_manage_](https://cloud.google.com/compute/docs/instance-groups/), dimana setiap Node -dihancurkan secara berurutan dan kemudian dibuat ulang dengan perangkat lunak baru. Semua Pod yang berjalan di Node tersebut harus -dikontrol oleh pengontrol replikasi (_Replication Controller_), atau dibuat ulang secara manual setelah peluncuran. - -Pembaruan versi pada klaster open source Google Compute Engine (GCE) yang dikontrol oleh skrip `cluster/gce/upgrade.sh`. - -Dapatkan penggunaan dengan menjalankan `cluster/gce/upgrade.sh -h`. - -Misalnya, untuk meningkatkan hanya _control plane_ kamu ke versi tertentu (v1.0.2): - -```shell -cluster/gce/upgrade.sh -M v1.0.2 -``` - -Sebagai alternatif, untuk meningkatkan seluruh klaster kamu ke rilis yang stabil terbaru gunakan: - -```shell -cluster/gce/upgrade.sh release/stable -``` - -### Memperbarui klaster Google Kubernetes Engine - -Google Kubernetes Engine secara otomatis memperbarui komponen _control plane_ (misalnya, `kube-apiserver`, ` kube-scheduler`) ke versi yang terbaru. Ini juga menangani pembaruan sistem operasi dan komponen lain yang dijalankan oleh _control plane_. - -Proses pembaruan Node dimulai oleh pengguna dan dijelaskan dalam [Dokumentasi Google Kubernetes Engine](https://cloud.google.com/kubernetes-engine/docs/clusters/upgrade). - -### Memperbarui klaster Amazon EKS - -Komponen _control plane_ klaster pada Amazon EKS dapat diperbarui dengan menggunakan eksctl, AWS Management Console, atau AWS CLI. Prosesnya dimulai oleh pengguna dan dijelaskan di [Dokumentasi Amazon EKS](https://docs.aws.amazon.com/eks/latest/userguide/update-cluster.html). - -### Memperbarui klaster Oracle Cloud Infrastructure Container Engine untuk Kubernetes (OKE) - -Oracle membuat dan mengelola sekumpulan Node _control plane_ pada _control plane_ Oracle atas nama kamu (dan infrastruktur Kubernetes terkait seperti Node etcd) untuk memastikan kamu memiliki Kubernetes _control plane_ yang terkelola dengan ketersedian tinggi. Kamu juga dapat memperbarui Node _control plane_ ini dengan mulus ke versi Kubernetes baru tanpa berhenti. Tindakan ini dijelaskan dalam [Dokumentasi OKE](https://docs.cloud.oracle.com/iaas/Content/ContEng/Tasks/contengupgradingk8smasternode.htm). - -### Memperbarui klaster pada platform yang lain - -Penyedia dan alat yang berbeda akan mengelola pembaruan secara berbeda. Kamu disarankan untuk membaca dokumentasi utama mereka terkait pembaruan. - -* [kops](https://github.com/kubernetes/kops) -* [kubespray](https://github.com/kubernetes-incubator/kubespray) -* [CoreOS Tectonic](https://coreos.com/tectonic/docs/latest/admin/upgrade.html) -* [Digital Rebar](https://provision.readthedocs.io/en/tip/doc/content-packages/krib.html) -* ... - -Untuk memperbarukan sebuah klaster pada platform yang tidak disebutkan dalam daftar di atas, periksa urutan pembaruan komponen pada -halaman [Versi Skewed](/docs/setup/release/version-skew-policy/#supported-component-upgrade-order). - -## Merubah ukuran klaster - -Jika klaster kamu kekurangan sumber daya, kamu dapat dengan mudah menambahkan lebih banyak mesin ke klaster tersebut jika klaster kamu -menjalankan [Mode Node Registrasi Sendiri](/docs/concepts/architecture/nodes/#self-registration-of-nodes). -Jika kamu menggunakan GCE atau Google Kubernetes Engine, itu dilakukan dengan mengubah ukuran grup _instance_ yang mengelola Node kamu. -Ini dapat dilakukan dengan mengubah jumlah _instance_ pada -`Compute > Compute Engine > Instance groups > your group > Edit group` -[Laman Google Cloud Console](https://console.developers.google.com) atau dengan baris perintah gcloud: - -```shell -gcloud compute instance-groups managed resize kubernetes-node-pool --size=42 --zone=$ZONE -``` - -Grup _instance_ akan menangani penempatan _image_ yang sesuai pada mesin baru dan memulainya, -sedangkan Kubelet akan mendaftarkan Node-nya ke server API agar tersedia untuk penjadwalan. -Jika kamu menurunkan skala grup _instance_, sistem akan secara acak memilih Node untuk dimatikan. - -Di lingkungan lain kamu mungkin perlu mengonfigurasi mesin sendiri dan memberi tahu Kubelet di mana server API mesin itu berjalan. - -### Merubah ukuran klaster Azure Kubernetes Service (AKS) - -Azure Kubernetes Service memungkinkan perubahan ukuran klaster yang dimulai oleh pengguna dari CLI atau -portal Azure dan dijelaskan dalam [Dokumentasi Azure AKS](https://docs.microsoft.com/en-us/azure/aks/scale-cluster). - - -### Penyekalaan otomatis klaster - -Jika kamu menggunakan GCE atau Google Kubernetes Engine, kamu dapat mengonfigurasi klaster kamu sehingga secara otomatis diskalakan berdasarkan -kebutuhan Pod. - -Seperti yang dideskripsikan dalam [Sumber daya komputasi](/id/docs/concepts/configuration/manage-resources-containers/), -pengguna dapat memesan berapa banyak CPU dan memori yang dialokasikan ke Pod. -Informasi ini digunakan oleh penjadwal Kubernetes untuk menemukan tempat menjalankan Pod. Jika -tidak ada Node yang memiliki kapasitas kosong yang cukup (atau tidak sesuai dengan persyaratan Pod yang lainnya) maka Pod -menunggu sampai beberapa Pod dihentikan atau Node baru ditambahkan. - -Penyekala otomatis klaster mencari Pod yang tidak dapat dijadwalkan dan memeriksa apakah perlu menambahkan Node baru, yang serupa -dengan Node yang lain dalam klaster untuk membantu. Jika ya, maka itu mengubah ukuran klaster agar dapat mengakomodasi Pod yang menunggu. - -Penyekala otomatis klaster juga menurunkan skala klaster jika mengetahui bahwa satu atau beberapa Node tidak diperlukan lagi untuk -periode waktu tambahan (selama 10 menit tetapi dapat berubah di masa mendatang). - -Penyekala otomatis klaster dikonfigurasikan untuk per grup _instance_ (GCE) atau kumpulan Node (Google Kubernetes Engine). - -Jika kamu menggunakan GCE, kamu dapat mengaktifkannya sambil membuat klaster dengan skrip kube-up.sh. -Untuk mengonfigurasi penyekala otomatis klaster, kamu harus menyetel tiga variabel lingkungan: - -* `KUBE_ENABLE_CLUSTER_AUTOSCALER` - mengaktifkan penyekala otomatis klaster kalau di setel menjadi _true_. -* `KUBE_AUTOSCALER_MIN_NODES` - minimal jumlah Node dalam klaster. -* `KUBE_AUTOSCALER_MAX_NODES` - maksimal jumlah Node dalam klaster. - -Contoh: - -```shell -KUBE_ENABLE_CLUSTER_AUTOSCALER=true KUBE_AUTOSCALER_MIN_NODES=3 KUBE_AUTOSCALER_MAX_NODES=10 NUM_NODES=5 ./cluster/kube-up.sh -``` - -Pada Google Kubernetes Engine, kamu mengonfigurasi penyekala otomatis klaster baik saat pembuatan atau pembaruan klaster atau saat membuat kumpulan Node tertentu -(yang ingin kamu skalakan secara otomatis) dengan meneruskan _flag_ `--enable-autoscaling`, `--min-nodes` dan `--max-nodes` -yang sesuai dengan perintah `gcloud`. - -Contoh: - -```shell -gcloud container clusters create mytestcluster --zone=us-central1-b --enable-autoscaling --min-nodes=3 --max-nodes=10 --num-nodes=5 -``` - -```shell -gcloud container clusters update mytestcluster --enable-autoscaling --min-nodes=1 --max-nodes=15 -``` - -**Penyekala otomatis klaster mengharapkan bahwa Node belum dimodifikasi secara manual (misalnya dengan menambahkan label melalui kubectl) karena properti tersebut tidak akan disebarkan ke Node baru dalam grup _instance_ yang sama.** - -Untuk detail selengkapnya tentang cara penyekala otomatis klaster memutuskan apakah, kapan dan bagaimana -melakukan penyekalaan sebuah klaster, silahkan lihat dokumentasi [FAQ](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md) -dari proyek penyekala otomatis klaster. - -## Memelihara dalam Node - -Jika kamu perlu memulai ulang Node (seperti untuk pembaruan kernel, pembaruan libc, pembaruan perangkat keras, dll.) dan waktu kegagalan (_downtime_) yang -singkat, lalu ketika Kubelet memulai ulang, maka ia akan mencoba untuk memulai ulang Pod yang dijadwalkan. Jika mulai ulang membutuhkan waktu yang lebih lama -(waktu bawaan adalah 5 menit, yang dikontrol oleh `--pod-eviction-timeout` pada _controller-manager_), -maka pengontrol Node akan menghentikan Pod yang terikat ke Node yang tidak tersedia. Jika ada yang sesuai dengan -kumpulan replika (atau pengontrol replikasi), maka salinan baru dari Pod akan dimulai pada Node yang berbeda. Jadi, dalam kasus di mana semua -Pod direplikasi, pembaruan dapat dilakukan tanpa koordinasi khusus, dengan asumsi bahwa tidak semua Node akan mati pada saat yang bersamaan. - -Jika kamu ingin lebih mengontrol proses pembaruan, kamu dapat menggunakan alur kerja berikut ini: - -Gunakan `kubectl drain` untuk meghentikan perlahan-lahan semua Pod dalam Node ketika menandai Node sebagai _unschedulable_: - -```shell -kubectl drain $NODENAME -``` - -Ini mencegah Pod baru mendarat pada Node saat kamu mencoba melepaskannya. - -Untuk Pod dengan sebuah kumpulan replika, Pod tersebut akan diganti dengan Pod baru yang akan dijadwalkan ke Node baru. Selain itu, jika Pod adalah bagian dari layanan, maka klien akan secara otomatis dialihkan ke Pod baru. - -Untuk Pod yang tidak memiliki replika, kamu perlu memunculkan salinan baru dari Pod tersebut, dan menganggapnya bukan bagian dari layanan, alihkan klien ke Pod tersebut. - -Lakukan pekerjaan pemeliharaan pada Node. - -Buat Node dapat dijadwal lagi: - - -```shell -kubectl uncordon $NODENAME -``` - -Jika kamu menghapus Node dari _instance_ VM dan membuat yang baru, maka sumber daya Node baru yang dapat dijadwalkan akan -dibuat secara otomatis (jika kamu menggunakan penyedia cloud yang mendukung -pencarian Node; saat ini hanya Google Compute Engine, tidak termasuk CoreOS di Google Compute Engine menggunakan kube-register). -Lihatlah [Node](/docs/concepts/architecture/nodes/) untuk lebih detail. - -## Topik lebih lanjut - -### Mengaktifkan atau menonaktifkan versi API untuk klaster kamu - -Versi API spesifik dapat dinyalakan dan dimatikan dengan meneruskan _flag_ `--runtime-config=api/` ketika menjalankan server API. Sebagai contoh: untuk menyalakan APIv1, teruskan `--runtime-config=api/v1=false`. -_runtime-config_ juga mendukung 2 kunci khusus: api/all dan api/legacy yang masing-masing untuk mengontrol semua dan API lama. -Sebagai contoh, untuk mematikan versi API semua kecuali v1, teruskan `--runtime-config=api/all=false,api/v1=true`. -Untuk tujuan _flag_ ini, API lama adalah API yang sudah tidak digunakan lagi secara eksplisit (misalnya, `v1beta3`). - -### Mengalihkan versi API penyimpanan dari klaster kamu - -Objek yang disimpan ke diska untuk representasi internal klaster dari sumber daya Kubernetes yang aktif dalam klaster ditulis menggunakan versi API tertentu. -Saat API yang didukung berubah, objek ini mungkin perlu ditulis ulang dalam API yang lebih baru. Kegagalan melakukan ini pada akhirnya akan menghasilkan sumber daya yang tidak lagi dapat didekodekan atau digunakan -oleh server API Kubernetes. - -### Mengalihkan berkas konfigurasi kamu ke versi API baru - -Kamu dapat menggunakan perintah `kubectl convert` untuk mengubah berkas konfigurasi di antara versi API berbeda. - -```shell -kubectl convert -f pod.yaml --output-version v1 -``` - -Untuk opsi yang lainnya, silakan merujuk pada penggunaan dari perintah [kubectl convert](/docs/reference/generated/kubectl/kubectl-commands#convert). - - diff --git a/static/_redirects b/static/_redirects index 8ff4ed3722..c92804abe4 100644 --- a/static/_redirects +++ b/static/_redirects @@ -29,6 +29,7 @@ /docs/admin/authorization/rbac.md /docs/admin/authorization/rbac/ 301 /docs/admin/cluster-components/ /docs/concepts/overview/components/ 301 /docs/admin/cluster-management/ /docs/tasks/administer-cluster/ 302 +/id/docs/admin/cluster-management/ /id/docs/tasks/administer-cluster/ 302 /docs/admin/cluster-troubleshooting/ /docs/tasks/debug-application-cluster/debug-cluster/ 301 /docs/admin/daemons/ /docs/concepts/workloads/controllers/daemonset/ 301 /docs/admin/disruptions/ /docs/concepts/workloads/pods/disruptions/ 301 From 2325d540bf9b8d8d8a2627c056b370464e943b4e Mon Sep 17 00:00:00 2001 From: Aris Cahyadi Risdianto Date: Sun, 4 Apr 2021 22:57:41 +0800 Subject: [PATCH 101/104] moving pod-overhead into scheduling-eviction. --- .../{configuration => scheduling-eviction}/pod-overhead.md | 0 static/_redirects | 1 + 2 files changed, 1 insertion(+) rename content/id/docs/concepts/{configuration => scheduling-eviction}/pod-overhead.md (100%) diff --git a/content/id/docs/concepts/configuration/pod-overhead.md b/content/id/docs/concepts/scheduling-eviction/pod-overhead.md similarity index 100% rename from content/id/docs/concepts/configuration/pod-overhead.md rename to content/id/docs/concepts/scheduling-eviction/pod-overhead.md diff --git a/static/_redirects b/static/_redirects index c92804abe4..db9f04df02 100644 --- a/static/_redirects +++ b/static/_redirects @@ -509,3 +509,4 @@ /docs/tasks/tools/install-minikube/ https://minikube.sigs.k8s.io/docs/start/ 302 /docs/concepts/configuration/pod-overhead/ /docs/concepts/scheduling-eviction/pod-overhead/ 301 +/id/docs/concepts/configuration/pod-overhead/ /id/docs/concepts/scheduling-eviction/pod-overhead/ 301 From fe9e5a80ad2be0e736cc05fbff1dd469f046b551 Mon Sep 17 00:00:00 2001 From: Justas Date: Sun, 4 Apr 2021 10:33:36 +0300 Subject: [PATCH 102/104] Fix label selector in Using Source IP tutorial Before: ```sh controlplane $ kubectl delete svc -l run=source-ip-app No resources found ``` ```sh k get svc --show-labels NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE LABELS clusterip ClusterIP 10.110.247.112 80/TCP 28m app=source-ip-app kubernetes ClusterIP 10.96.0.1 443/TCP 49m component=apiserver,provider=kubernetes loadbalancer LoadBalancer 10.111.123.206 80:31111/TCP 9m59s app=source-ip-app nodeport NodePort 10.108.129.31 80:32503/TCP 22m app=source-ip-app ``` After: ```sh controlplane $ kubectl delete svc -l app=source-ip-app service "clusterip" deleted service "loadbalancer" deleted service "nodeport" deleted ``` Update source-ip.md Update source-ip.md Update source-ip.md --- content/en/docs/tutorials/services/source-ip.md | 2 +- content/ja/docs/tutorials/services/source-ip.md | 2 +- content/ko/docs/tutorials/services/source-ip.md | 2 +- content/zh/docs/tutorials/services/source-ip.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/content/en/docs/tutorials/services/source-ip.md b/content/en/docs/tutorials/services/source-ip.md index 4ed574e158..0a2d4b5929 100644 --- a/content/en/docs/tutorials/services/source-ip.md +++ b/content/en/docs/tutorials/services/source-ip.md @@ -425,7 +425,7 @@ the `service.spec.healthCheckNodePort` field on the Service. Delete the Services: ```shell -kubectl delete svc -l run=source-ip-app +kubectl delete svc -l app=source-ip-app ``` Delete the Deployment, ReplicaSet and Pod: diff --git a/content/ja/docs/tutorials/services/source-ip.md b/content/ja/docs/tutorials/services/source-ip.md index 17317bbeae..505ba8ef45 100644 --- a/content/ja/docs/tutorials/services/source-ip.md +++ b/content/ja/docs/tutorials/services/source-ip.md @@ -399,7 +399,7 @@ client_address=198.51.100.79 Serviceを削除します。 ```shell -kubectl delete svc -l run=source-ip-app +kubectl delete svc -l app=source-ip-app ``` Deployment、ReplicaSet、Podを削除します。 diff --git a/content/ko/docs/tutorials/services/source-ip.md b/content/ko/docs/tutorials/services/source-ip.md index dec30dc54b..6874d6669b 100644 --- a/content/ko/docs/tutorials/services/source-ip.md +++ b/content/ko/docs/tutorials/services/source-ip.md @@ -426,7 +426,7 @@ HTTP 헬스 체크를 생성하여 서비스를 삭제한다. ```shell -kubectl delete svc -l run=source-ip-app +kubectl delete svc -l app=source-ip-app ``` 디플로이먼트, 레플리카셋 그리고 파드를 삭제한다. diff --git a/content/zh/docs/tutorials/services/source-ip.md b/content/zh/docs/tutorials/services/source-ip.md index f989e93c70..26baeebbd9 100644 --- a/content/zh/docs/tutorials/services/source-ip.md +++ b/content/zh/docs/tutorials/services/source-ip.md @@ -387,7 +387,7 @@ __跨平台支持__ 删除服务: ```console -$ kubectl delete svc -l run=source-ip-app +$ kubectl delete svc -l app=source-ip-app ``` From 8441afaac19ef2f51e1c6094e098760e6b0a7544 Mon Sep 17 00:00:00 2001 From: Ricardo Katz Date: Mon, 5 Apr 2021 10:28:13 -0300 Subject: [PATCH 103/104] Add initial portuguese translation to runtime class (#27302) * Add initial portuguese translation to runtime class * Apply suggestions from code review Co-authored-by: Diego W. Antunes * Typo correct Co-authored-by: Diego W. Antunes --- .../docs/concepts/containers/runtime-class.md | 179 ++++++++++++++++++ .../pt/docs/reference/glossary/containerd.md | 19 ++ content/pt/docs/reference/glossary/cri-o.md | 23 +++ content/pt/docs/reference/glossary/cri.md | 18 ++ 4 files changed, 239 insertions(+) create mode 100644 content/pt/docs/concepts/containers/runtime-class.md create mode 100644 content/pt/docs/reference/glossary/containerd.md create mode 100644 content/pt/docs/reference/glossary/cri-o.md create mode 100644 content/pt/docs/reference/glossary/cri.md diff --git a/content/pt/docs/concepts/containers/runtime-class.md b/content/pt/docs/concepts/containers/runtime-class.md new file mode 100644 index 0000000000..70e42a78f0 --- /dev/null +++ b/content/pt/docs/concepts/containers/runtime-class.md @@ -0,0 +1,179 @@ +--- +title: Classes de execução +content_type: concept +weight: 20 +--- + + + +{{< feature-state for_k8s_version="v1.20" state="stable" >}} + +Essa página descreve o recurso _RuntimeClass_ e a seleção do mecanismo do agente de execução. + +RuntimeClass é uma funcionalidade para selecionar as configurações do agente de execução do contêiner. +A configuração do agente de execução de contêineres é usada para executar os contêineres de um Pod. + + + + +## Motivação + +Você pode configurar um _RuntimeClass_ diferente entre os diferentes Pods para prover +um equilíbrio entre performance versus segurança. Por exemplo, se parte de sua carga de +trabalho necessita de um alto nível de garantia de segurança da informação, você pode +optar em executar esses Pods em um agente de execução que usa virtualização de hardware. +Você então terá o benefício do isolamento extra de um agente de execução alternativo, ao +custo de uma latência adicional. + +Você pode ainda usar um _RuntimeClass_ para executar diferentes Pods com o mesmo agente +de execução de contêineres mas com diferentes configurações. + +## Configuração + +1. Configure a implementação do CRI nos nós (depende do agente de execução) +2. Crie o recurso RuntimeClass correspondente. + +### 1. Configure a implementação do CRI nos nós + +As configurações disponíveis através do RuntimeClass sáo dependentes da implementação do +_Container Runtime Interface_ ({{< glossary_tooltip term_id="cri" >}}). Veja a documentação correspondente [abaixo](#configuração-do-cri) para a +sua implementação CRI para verificar como configurar. + +{{< note >}} +RuntimeClass assume uma configuração homogênea de nós entre todo o cluster por padrão +(o que significa que todos os nós estão configurados do mesmo jeito referente aos agentes de +execução). Para suportar configurações heterogêneas, veja [Associação](#associação) abaixo. +{{< /note >}} + +As configurações possuem um nome `handler` correspondente, referenciado pelo RuntimeClass. +Esse nome deve ser um valor DNS 1123 válido (letras, números e o carácter `-`). + +### 2. Crie o recurso RuntimeClass correspondente + +As etapas de configuração no passo 1 devem todas estar associadas a um nome para o campo `handler` +que identifica a configuração. Para cada um, crie o objeto RuntimeClass correspondente. + +O recurso RuntimeClass atualmente possui apenas 2 campos significativos: o nome do RuntimeClass +(`metadata.name`) e o agente (`handler`). A definição do objeto se parece conforme a seguir: + +```yaml +apiVersion: node.k8s.io/v1 # RuntimeClass é definido no grupo de API node.k8s.io +kind: RuntimeClass +metadata: + name: myclass # O nome que o RuntimeClass será chamado como + # RuntimeClass é um recurso global, e não possui namespace. +handler: myconfiguration # Nome da configuração CRI correspondente +``` + +O nome de um objeto RuntimeClass deve ser um +[nome de subdomínio DNS](/docs/concepts/overview/working-with-objects/names#dns-subdomain-names) válido. + +{{< note >}} +É recomendado que operações de escrita no objeto RuntimeClass (criar/atualizar/patch/apagar) +sejam restritas a administradores do cluster. Isso geralmente é o padrão. Veja [Visão Geral +de autorizações](/docs/reference/access-authn-authz/authorization/) para maiores detalhes. +{{< /note >}} + +## Uso + +Uma vez que as classes de execução estão configuradas no cluster, usar elas é relativamente +simples. Especifique um `runtimeClassName` na especificação do Pod. Por exemplo: + +```yaml +apiVersion: v1 +kind: Pod +metadata: + name: mypod +spec: + runtimeClassName: myclass + # ... +``` + +Isso irá instruir o kubelet a usar o RuntimeClass nomeado acima (myclass) para esse Pod. Se +o nome do RuntimeClass não existir, ou o CRI não puder executar a solicitação, o Pod entrará na [fase +final](/docs/concepts/workloads/pods/pod-lifecycle/#pod-phase) `Failed`. Procure por um +[evento](/docs/tasks/debug-application-cluster/debug-application-introspection/) correspondente +para uma mensagem de erro. + +Se nenhum `runtimeClassName` for especificado, o RuntimeHandler padrão será utilizado, que é equivalente +ao comportamento quando a funcionalidade de RuntimeClass está desativada. + +### Configuração do CRI + +Para maiores detalhes de configuração dos agentes de execução CRI, veja [instalação do CRI](/docs/setup/production-environment/container-runtimes/). + +#### dockershim + +O CRI dockershim embutido no Kubernetes não suporta outros agentes de execução. + +#### {{< glossary_tooltip term_id="containerd" >}} + +Agentes de execução são configurados através da configuração do containerd em +`/etc/containerd/config.toml`. Agentes válidos são configurados sob a seção de `runtimes`: + +``` +[plugins.cri.containerd.runtimes.${HANDLER_NAME}] +``` + +Veja a documentação de configuração do containerd para maiores detalhes: +https://github.com/containerd/cri/blob/master/docs/config.md + +#### {{< glossary_tooltip term_id="cri-o" >}} + +Agentes de execução são configurados através da configuração do CRI-O em `/etc/crio/crio.conf`. +Agentes válidos são configurados na seção [crio.runtime +table](https://github.com/cri-o/cri-o/blob/master/docs/crio.conf.5.md#crioruntime-table): + +``` +[crio.runtime.runtimes.${HANDLER_NAME}] + runtime_path = "${PATH_TO_BINARY}" +``` + +Veja a [documentação de configuração](https://raw.githubusercontent.com/cri-o/cri-o/9f11d1d/docs/crio.conf.5.md) do CRI-O para maiores detalhes. + +## Associação + +{{< feature-state for_k8s_version="v1.16" state="beta" >}} + +Ao especificar o campo `scheduling` para um RuntimeClass, você pode colocar limites e +garantir que os Pods executando dentro de uma RuntimeClass sejam associados a nós que +suportem eles. Se o `scheduling` não estiver configurado, assume-se que esse RuntimeClass +é suportado por todos os nós. + +Para garantir que os Pods sejam executados em um nó que suporte um RuntimeClass específico, +aquele conjunto de nós deve possuir uma marca/label padrão que é selecionado pelo campo +`runtimeclass.scheduling.nodeSelector`. O nodeSelector do RuntimeClass é combinado com o +nodeSelector do Pod em tempo de admissão, obtendo a intersecção do conjunto de nós selecionado +por cada. Se existir um conflito, o pod será rejeitado. + +Se os nós suportados possuírem marcação de restrição para prevenir outros Pods com uma +classe de execução diferente de executar no nó, você pode adicionar o campo `tolerations` +ao objeto RuntimeClass. Assim como com o `nodeSelector`, o `tolerations` é combinado com +o campo `tolerations` do Pod em tempo de admissão, efetivamente pegando a intersecção do +conjunto de nós aplicáveis para cada. + +Para saber mais sobre a configuração de seleção de nós e tolerâncias, veja [Associando Pods a +Nós](/docs/concepts/scheduling-eviction/assign-pod-node/). + +### Sobrecarga de Pods + +{{< feature-state for_k8s_version="v1.18" state="beta" >}} + +Você pode especificar os recursos extra que estão associados à execução de um Pod. Declarar esses +recursos extra permite ao cluster (incluindo o agendador/scheduler de pods) contabilizar por +esses recursos quando estiver decidindo sobre Pods e recursos. Para usar a contabilização +desses recursos extras, você deve estar com o [feature gate](/docs/reference/command-line-tools-reference/feature-gates/) +PodOverhead habilitado (ele já está habilitado por padrão). + +Os recursos extras utilizados são especificados no objeto RuntimeClass através do campo `overhead`. +Ao usar esses campos, você especifica o uso extra de recursos necessários para executar +Pods utilizando-se desse Runtimeclass e assim contabilizar esses recursos para o Kubernetes. + + +## {{% heading "whatsnext" %}} + + +- [RuntimeClass Design](https://github.com/kubernetes/enhancements/blob/master/keps/sig-node/585-runtime-class/README.md) +- [RuntimeClass Scheduling Design](https://github.com/kubernetes/enhancements/blob/master/keps/sig-node/585-runtime-class/README.md#runtimeclass-scheduling) +- Leia mais sobre [Sobrecarga de Pods](/docs/concepts/scheduling-eviction/pod-overhead/) +- [PodOverhead Feature Design](https://github.com/kubernetes/enhancements/blob/master/keps/sig-node/20190226-pod-overhead.md) diff --git a/content/pt/docs/reference/glossary/containerd.md b/content/pt/docs/reference/glossary/containerd.md new file mode 100644 index 0000000000..0eee599829 --- /dev/null +++ b/content/pt/docs/reference/glossary/containerd.md @@ -0,0 +1,19 @@ +--- +title: containerd +id: containerd +date: 2019-05-14 +full_link: https://containerd.io/docs/ +short_description: > + Um agente de execução de contêiner com enfase em simplicidade, robustez e portabilidade + +aka: +tags: +- tool +--- + Um agente de execução de contêiner com enfase em simplicidade, robustez e portabilidade + + + +containerd é um agente de execução de {{< glossary_tooltip text="contêiner" term_id="container" >}} +que executa um serviço no Linux ou Windows. containerd é responsável por buscar e +armazenar as imagens de contêiner, executar contêineres, prover acesso à rede e mais. diff --git a/content/pt/docs/reference/glossary/cri-o.md b/content/pt/docs/reference/glossary/cri-o.md new file mode 100644 index 0000000000..37da1679a1 --- /dev/null +++ b/content/pt/docs/reference/glossary/cri-o.md @@ -0,0 +1,23 @@ +--- +title: CRI-O +id: cri-o +date: 2019-05-14 +full_link: https://cri-o.io/#what-is-cri-o +short_description: > + Um agente de execução leve de contêineres criado especificamente para o Kubernetes + +aka: +tags: +- tool +--- +Uma ferramenta que permite você usar agentes de execução de contêineres OCI com o CRI do Kubernetes + + + +CRI-O é uma implementação do {{< glossary_tooltip term_id="cri" >}} +que permite usar agentes de execução de {{< glossary_tooltip text="contêiner" term_id="container" >}} +compatíveis com as [especificações](https://www.github.com/opencontainers/runtime-spec) da Open Container Initiative (OCI). + +Usar o CRI-O permite ao Kubernetes utilizar-se de qualquer agente de execução compatível +com o OCI para executar {{< glossary_tooltip text="Pods" term_id="pod" >}}, e obter imagens +de contêineres de registros remotos. diff --git a/content/pt/docs/reference/glossary/cri.md b/content/pt/docs/reference/glossary/cri.md new file mode 100644 index 0000000000..cced4ad430 --- /dev/null +++ b/content/pt/docs/reference/glossary/cri.md @@ -0,0 +1,18 @@ +--- +title: Container runtime interface (CRI) +id: cri +date: 2019-03-07 +full_link: /docs/concepts/overview/components/#container-runtime +short_description: > + Uma API para agentes de execução de contêineres se integrarem com o kubelet + + +aka: +tags: +- fundamental +--- +A interface de execução de contêiner (CRI) é uma API para agentes de execução de +contêineres se integrarem com o kubelet em um nó. + + +Para maiores informações, veja as APIs e especificações do [CRI](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-node/container-runtime-interface.md). From 17b5158f2431b9e2dda93de7f396a442db81c95a Mon Sep 17 00:00:00 2001 From: joostas Date: Mon, 5 Apr 2021 21:11:18 +0300 Subject: [PATCH 104/104] [ru] "kubectl for Docker Users" use "kubectl create deployment" command to run pod Before: Example runs pod without creating deployment ```sh kubectl run --image=nginx nginx-app --port=80 ``` But later in document mentions: ``` deployment "nginx-app" created ``` After: Pod is created with deployment. (Aligned with other language examples) --- .../reference/kubectl/docker-cli-to-kubectl.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/content/ru/docs/reference/kubectl/docker-cli-to-kubectl.md b/content/ru/docs/reference/kubectl/docker-cli-to-kubectl.md index 99a9e20d8c..4d834098c6 100644 --- a/content/ru/docs/reference/kubectl/docker-cli-to-kubectl.md +++ b/content/ru/docs/reference/kubectl/docker-cli-to-kubectl.md @@ -34,12 +34,20 @@ kubectl: ```shell # запустить под, в котором работает nginx -kubectl run --image=nginx nginx-app --port=80 --env="DOMAIN=cluster" +kubectl create deployment --image=nginx nginx-app ``` ``` deployment "nginx-app" created ``` +```shell +# add env to nginx-app +kubectl set env deployment/nginx-app DOMAIN=cluster +``` +``` +deployment.apps/nginx-app env updated +``` + {{< note >}} Команды `kubectl` выводят тип и имя созданного или измененного ресурса, который затем может быть использован в последующих командах. После создания объекта Deployment можно открыть новый сервис Service. {{< /note >}} @@ -260,7 +268,7 @@ nginx-app 1/1 1 1 2m ``` ```shell -kubectl get po -l run=nginx-app +kubectl get po -l app=nginx-app ``` ``` NAME READY STATUS RESTARTS AGE @@ -274,7 +282,7 @@ deployment "nginx-app" deleted ``` ```shell -kubectl get po -l run=nginx-app +kubectl get po -l app=nginx-app # Return nothing ```