From 703f8b92f514fd6f84ff8b3e6c577e80f640dfdb Mon Sep 17 00:00:00 2001 From: Victor Palade Date: Thu, 5 Aug 2021 01:06:02 +0200 Subject: [PATCH 01/68] Tracking commit for v1.23 docs From 5f192f2cb1df5b15aa1574efd565867815c3073e Mon Sep 17 00:00:00 2001 From: Sascha Grunert Date: Tue, 17 Aug 2021 09:51:11 +0200 Subject: [PATCH 02/68] Add note about deprecated seccomp annotation We now add a note to clarify that the annotations are deprecated and will become non-functional in v1.25. Signed-off-by: Sascha Grunert --- .../docs/reference/labels-annotations-taints.md | 8 +++++++- content/en/docs/tutorials/clusters/seccomp.md | 16 ++++++++++++---- 2 files changed, 19 insertions(+), 5 deletions(-) diff --git a/content/en/docs/reference/labels-annotations-taints.md b/content/en/docs/reference/labels-annotations-taints.md index 07e6d19426dd8..e2fc2b317e941 100644 --- a/content/en/docs/reference/labels-annotations-taints.md +++ b/content/en/docs/reference/labels-annotations-taints.md @@ -425,4 +425,10 @@ policies to apply when validating a submitted Pod. Note that warnings are also d or updating objects that contain Pod templates, such as Deployments, Jobs, StatefulSets, etc. See [Enforcing Pod Security at the Namespace Level](/docs/concepts/security/pod-security-admission) -for more information. \ No newline at end of file +for more information. + +## seccomp.security.alpha.kubernetes.io/pod and container.seccomp.security.alpha.kubernetes.io/[NAME] (deprecated) + +The seccomp annotations have been deprecated since Kubernetes v1.19 and will +become non-functional in v1.25. Please use the `seccompProfile` of the +`SecurityContext` instead. \ No newline at end of file diff --git a/content/en/docs/tutorials/clusters/seccomp.md b/content/en/docs/tutorials/clusters/seccomp.md index c510f4c70768d..ce16eb524a629 100644 --- a/content/en/docs/tutorials/clusters/seccomp.md +++ b/content/en/docs/tutorials/clusters/seccomp.md @@ -170,12 +170,20 @@ Download the correct manifest for your Kubernetes version: {{< tab name="v1.19 or Later (GA)" >}} {{< codenew file="pods/security/seccomp/ga/audit-pod.yaml" >}} {{< /tab >}}} -{{{< tab name="Pre-v1.19 (alpha)" >}} +{{{< tab name="Pre-v1.19 (deprecated)" >}} {{< codenew file="pods/security/seccomp/alpha/audit-pod.yaml" >}} {{< /tab >}} {{< /tabs >}}
+{{< note >}} +The functional support for the already deprecated seccomp annotations +`seccomp.security.alpha.kubernetes.io/pod` (for the whole pod) and +`container.seccomp.security.alpha.kubernetes.io/[name]` (for a single container) +is going to be removed with the release of Kubernetes v1.25. Please always use +the native API fields in favor of the annotations. +{{< /note >}} + Create the Pod in the cluster: ``` @@ -270,7 +278,7 @@ Download the correct manifest for your Kubernetes version: {{< tab name="v1.19 or Later (GA)" >}} {{< codenew file="pods/security/seccomp/ga/violation-pod.yaml" >}} {{< /tab >}}} -{{{< tab name="Pre-v1.19 (alpha)" >}} +{{{< tab name="Pre-v1.19 (deprecated)" >}} {{< codenew file="pods/security/seccomp/alpha/violation-pod.yaml" >}} {{< /tab >}} {{< /tabs >}} @@ -321,7 +329,7 @@ Download the correct manifest for your Kubernetes version: {{< tab name="v1.19 or Later (GA)" >}} {{< codenew file="pods/security/seccomp/ga/fine-pod.yaml" >}} {{< /tab >}}} -{{{< tab name="Pre-v1.19 (alpha)" >}} +{{{< tab name="Pre-v1.19 (deprecated)" >}} {{< codenew file="pods/security/seccomp/alpha/fine-pod.yaml" >}} {{< /tab >}} {{< /tabs >}} @@ -403,7 +411,7 @@ Download the correct manifest for your Kubernetes version: {{< tab name="v1.19 or Later (GA)" >}} {{< codenew file="pods/security/seccomp/ga/default-pod.yaml" >}} {{< /tab >}}} -{{{< tab name="Pre-v1.19 (alpha)" >}} +{{{< tab name="Pre-v1.19 (deprecated)" >}} {{< codenew file="pods/security/seccomp/alpha/default-pod.yaml" >}} {{< /tab >}} {{< /tabs >}} From 5db769d46c22d1b05b0ca73ac4af10a9ebdbb2e4 Mon Sep 17 00:00:00 2001 From: Jesse Butler Date: Thu, 9 Sep 2021 08:52:52 -0400 Subject: [PATCH 03/68] update config.toml for 1.23 release --- config.toml | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/config.toml b/config.toml index c8953f2f7d7eb..7c7f88a4e60c9 100644 --- a/config.toml +++ b/config.toml @@ -138,10 +138,10 @@ time_format_default = "January 02, 2006 at 3:04 PM PST" description = "Production-Grade Container Orchestration" showedit = true -latest = "v1.22" +latest = "v1.23" -fullversion = "v1.22.0" -version = "v1.22" +fullversion = "v1.23.0" +version = "v1.23" githubbranch = "main" docsbranch = "main" deprecated = false @@ -178,12 +178,19 @@ js = [ ] [[params.versions]] -fullversion = "v1.22.0" -version = "v1.22" -githubbranch = "v1.22.0" +fullversion = "v1.23.0" +version = "v1.23" +githubbranch = "v1.23.0" docsbranch = "main" url = "https://kubernetes.io" +[[params.versions]] +fullversion = "v1.22.1" +version = "v1.22" +githubbranch = "v1.22.1" +docsbranch = "release-1.22" +url = "https://v1-22.docs.kubernetes.io" + [[params.versions]] fullversion = "v1.21.4" version = "v1.21" @@ -205,13 +212,6 @@ githubbranch = "v1.19.14" docsbranch = "release-1.19" url = "https://v1-19.docs.kubernetes.io" -[[params.versions]] -fullversion = "v1.18.20" -version = "v1.18" -githubbranch = "v1.18.20" -docsbranch = "release-1.18" -url = "https://v1-18.docs.kubernetes.io" - # User interface configuration [params.ui] # Enable to show the side bar menu in its compact state. From c189c2d162e5e283272551aca2e43130bd654054 Mon Sep 17 00:00:00 2001 From: Zovin Khanmohammed Date: Sun, 12 Sep 2021 04:56:06 -0500 Subject: [PATCH 04/68] Update docs to reflect newly support shells with autocompletions (#29610) * Update docs to reflect newly support shells with autocompletions * Update Windows docs to use Powershell instead of zsh * Adds a bit more explanation of the different lines. * Apply suggestions from code review Co-authored-by: Tim Bannister * Apply PR suggestions Co-authored-by: Tim Bannister --- .../included/optional-kubectl-configs-pwsh.md | 23 +++++++++++++++++++ .../docs/tasks/tools/install-kubectl-linux.md | 2 +- .../docs/tasks/tools/install-kubectl-macos.md | 2 +- .../tasks/tools/install-kubectl-windows.md | 7 +++--- 4 files changed, 28 insertions(+), 6 deletions(-) create mode 100644 content/en/docs/tasks/tools/included/optional-kubectl-configs-pwsh.md diff --git a/content/en/docs/tasks/tools/included/optional-kubectl-configs-pwsh.md b/content/en/docs/tasks/tools/included/optional-kubectl-configs-pwsh.md new file mode 100644 index 0000000000000..12e5d60c5d29b --- /dev/null +++ b/content/en/docs/tasks/tools/included/optional-kubectl-configs-pwsh.md @@ -0,0 +1,23 @@ +--- +title: "PowerShell auto-completion" +description: "Some optional configuration for powershell auto-completion." +headless: true +--- + +The kubectl completion script for PowerShell can be generated with the command `kubectl completion powershell`. + +To do so in all your shell sessions, add the following line to your `$PROFILE` file: + +```powershell +kubectl completion powershell | Out-String | Invoke-Expression +``` + +This command will regenerate the auto-completion script on every PowerShell start up. You can also add the generated script directly to your `$PROFILE` file. + +To add the generated script to your `$PROFILE` file, run the following line in your powershell prompt: + +```powershell +kubectl completion powershell >> $PROFILE +``` + +After reloading your shell, kubectl autocompletion should be working. diff --git a/content/en/docs/tasks/tools/install-kubectl-linux.md b/content/en/docs/tasks/tools/install-kubectl-linux.md index efb203f8b9563..3b48ce6790a59 100644 --- a/content/en/docs/tasks/tools/install-kubectl-linux.md +++ b/content/en/docs/tasks/tools/install-kubectl-linux.md @@ -176,7 +176,7 @@ kubectl version --client ### Enable shell autocompletion -kubectl provides autocompletion support for Bash and Zsh, which can save you a lot of typing. +kubectl provides autocompletion support for Bash, Zsh, Fish, and PowerShell, which can save you a lot of typing. Below are the procedures to set up autocompletion for Bash and Zsh. diff --git a/content/en/docs/tasks/tools/install-kubectl-macos.md b/content/en/docs/tasks/tools/install-kubectl-macos.md index b46ab0364037f..f2f7cf1a9c2e3 100644 --- a/content/en/docs/tasks/tools/install-kubectl-macos.md +++ b/content/en/docs/tasks/tools/install-kubectl-macos.md @@ -159,7 +159,7 @@ If you are on macOS and using [Macports](https://macports.org/) package manager, ### Enable shell autocompletion -kubectl provides autocompletion support for Bash and Zsh, which can save you a lot of typing. +kubectl provides autocompletion support for Bash, Zsh, Fish, and PowerShell which can save you a lot of typing. Below are the procedures to set up autocompletion for Bash and Zsh. diff --git a/content/en/docs/tasks/tools/install-kubectl-windows.md b/content/en/docs/tasks/tools/install-kubectl-windows.md index 8059fa7a3a626..2417d1a3c4bea 100644 --- a/content/en/docs/tasks/tools/install-kubectl-windows.md +++ b/content/en/docs/tasks/tools/install-kubectl-windows.md @@ -22,7 +22,6 @@ The following methods exist for installing kubectl on Windows: - [Install kubectl binary with curl on Windows](#install-kubectl-binary-with-curl-on-windows) - [Install on Windows using Chocolatey or Scoop](#install-on-windows-using-chocolatey-or-scoop) - ### Install kubectl binary with curl on Windows 1. Download the [latest release {{< param "fullversion" >}}](https://dl.k8s.io/release/{{< param "fullversion" >}}/bin/windows/amd64/kubectl.exe). @@ -134,11 +133,11 @@ Edit the config file with a text editor of your choice, such as Notepad. ### Enable shell autocompletion -kubectl provides autocompletion support for Bash and Zsh, which can save you a lot of typing. +kubectl provides autocompletion support for Bash, Zsh, Fish, and PowerShell, which can save you a lot of typing. -Below are the procedures to set up autocompletion for Zsh, if you are running that on Windows. +Below are the procedures to set up autocompletion for PowerShell. -{{< include "included/optional-kubectl-configs-zsh.md" >}} +{{< include "included/optional-kubectl-configs-pwsh.md" >}} ### Install `kubectl convert` plugin From dae1b392e6377f7e8c83863df86a75bf5e3cd92f Mon Sep 17 00:00:00 2001 From: siddhantprateek Date: Mon, 11 Oct 2021 18:32:45 +0530 Subject: [PATCH 05/68] replaced link from api-beta2 to api-beta3 Signed-off-by: siddhantprateek --- content/en/docs/reference/setup-tools/kubeadm/kubeadm-init.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 3779ec2fdfe77..60abb96e560ee 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/kubeadm-init.md +++ b/content/en/docs/reference/setup-tools/kubeadm/kubeadm-init.md @@ -127,7 +127,7 @@ If your configuration is not using the latest version it is **recommended** that the [kubeadm config migrate](/docs/reference/setup-tools/kubeadm/kubeadm-config/) command. For more information on the fields and usage of the configuration you can navigate to our -[API reference page](/docs/reference/config-api/kubeadm-config.v1beta2/). +[API reference page](/docs/reference/config-api/kubeadm-config.v1beta3/). ### Adding kube-proxy parameters {#kube-proxy} From bb634e6db9b439258dd5ec79c3a17f73a992f88c Mon Sep 17 00:00:00 2001 From: Tim Bannister Date: Sat, 16 Oct 2021 12:23:33 +0100 Subject: [PATCH 06/68] Revise seccomp tutorial - Drop docs for Kubernetes earlier than v1.19 - Have kubectl fetch manifests using HTTP where suitable - General tidying --- content/en/docs/tutorials/clusters/seccomp.md | 302 +++++++++--------- 1 file changed, 158 insertions(+), 144 deletions(-) diff --git a/content/en/docs/tutorials/clusters/seccomp.md b/content/en/docs/tutorials/clusters/seccomp.md index 3a883baf5e649..af8cb9e2efbeb 100644 --- a/content/en/docs/tutorials/clusters/seccomp.md +++ b/content/en/docs/tutorials/clusters/seccomp.md @@ -36,16 +36,18 @@ profiles that give only the necessary privileges to your container processes. ## {{% heading "prerequisites" %}} -{{< version-check >}} - In order to complete all steps in this tutorial, you must install -[kind](https://kind.sigs.k8s.io/docs/user/quick-start/) and -[kubectl](/docs/tasks/tools/). This tutorial will show examples -both alpha (new in v1.22) and generally available seccomp functionality. You should -make sure that your cluster is [configured -correctly](https://kind.sigs.k8s.io/docs/user/quick-start/#setting-kubernetes-version) +[kind](/docs/tasks/tools/#kind) and [kubectl](/docs/tasks/tools/#kubectl). + +This tutorial shows some examples that are still alpha (since v1.22) and +others that use only generally available seccomp functionality. You should +make sure that your cluster is +[configured correctly](https://kind.sigs.k8s.io/docs/user/quick-start/#setting-kubernetes-version) for the version you are using. +The tutorial also uses the `curl` tool for downloading examples to your computer. +You can adapt the steps to use a different tool if you prefer. + {{< note >}} It is not possible to apply a seccomp profile to a container running with `privileged: true` set in the container's `securityContext`. Privileged containers always @@ -54,53 +56,6 @@ run as `Unconfined`. -## Enable the use of `RuntimeDefault` as the default seccomp profile for all workloads - -{{< feature-state state="alpha" for_k8s_version="v1.22" >}} - -`SeccompDefault` is an optional kubelet -[feature gate](/docs/reference/command-line-tools-reference/feature-gates) as -well as corresponding `--seccomp-default` -[command line flag](/docs/reference/command-line-tools-reference/kubelet). -Both have to be enabled simultaneously to use the feature. - -If enabled, the kubelet will use the `RuntimeDefault` seccomp profile by default, which is -defined by the container runtime, instead of using the `Unconfined` (seccomp disabled) mode. -The default profiles aim to provide a strong set -of security defaults while preserving the functionality of the workload. It is -possible that the default profiles differ between container runtimes and their -release versions, for example when comparing those from CRI-O and containerd. - -Some workloads may require a lower amount of syscall restrictions than others. -This means that they can fail during runtime even with the `RuntimeDefault` -profile. To mitigate such a failure, you can: - -- Run the workload explicitly as `Unconfined`. -- Disable the `SeccompDefault` feature for the nodes. Also making sure that - workloads get scheduled on nodes where the feature is disabled. -- Create a custom seccomp profile for the workload. - -If you were introducing this feature into production-like cluster, the Kubernetes project -recommends that you enable this feature gate on a subset of your nodes and then -test workload execution before rolling the change out cluster-wide. - -More detailed information about a possible upgrade and downgrade strategy can be -found in the [related Kubernetes Enhancement Proposal (KEP)](https://github.com/kubernetes/enhancements/tree/a70cc18/keps/sig-node/2413-seccomp-by-default#upgrade--downgrade-strategy). - -Since the feature is in alpha state it is disabled per default. To enable it, -pass the flags `--feature-gates=SeccompDefault=true --seccomp-default` to the -`kubelet` CLI or enable it via the [kubelet configuration -file](/docs/tasks/administer-cluster/kubelet-config-file/). To enable the -feature gate in [kind](https://kind.sigs.k8s.io), ensure that `kind` provides -the minimum required Kubernetes version and enables the `SeccompDefault` feature -[in the kind configuration](https://kind.sigs.k8s.io/docs/user/quick-start/#enable-feature-gates-in-your-cluster): - -```yaml -kind: Cluster -apiVersion: kind.x-k8s.io/v1alpha4 -featureGates: - SeccompDefault: true -``` ## Create Seccomp Profiles @@ -120,7 +75,24 @@ into the cluster. {{< /tab >}}} {{< /tabs >}} -## Create a Local Kubernetes Cluster with Kind +Run these commands: + +```shell +mkdir ./profiles +curl -L -o profiles/audit.json https://k8s.io/examples/pods/security/seccomp/profiles/audit.json +curl -L -o profiles/violation.json https://k8s.io/examples/pods/security/seccomp/profiles/violation.json +curl -L -o profiles/fine-grained.json https://k8s.io/examples/pods/security/seccomp/profiles/fine-grained.json +ls profiles +``` + +You should see three profiles listed at the end of the final step: +``` +audit.json fine-grained.json violation.json +``` + + +## Create a Local Kubernetes Cluster with kind + For simplicity, [kind](https://kind.sigs.k8s.io/) can be used to create a single node cluster with the seccomp profiles loaded. Kind runs Kubernetes in Docker, @@ -129,35 +101,52 @@ to be mounted in the filesystem of each container similar to loading files onto a node. {{< codenew file="pods/security/seccomp/kind.yaml" >}} -
- -Download the example above, and save it to a file named `kind.yaml`. Then create -the cluster with the configuration. +Download that example kind configuration, and save it to a file named `kind.yaml`: +```shell +curl -L -O https://k8s.io/examples/pods/security/seccomp/kind.yaml ``` + +You can set a specific Kubernetes version by setting the node's container image. +See [Nodes](https://kind.sigs.k8s.io/docs/user/configuration/#nodes) within the +kind documentation about configuration for more details on this. +This tutorial assumes you are using Kubernetes {{< param "version" >}}. + +As an alpha feature, you can configure Kubernetes to use the profile that the +{{< glossary_tooltip text="container runtime" term_id="container-runtime" >}} +prefers by default, rather than falling back to `Unconfined`. +If you want to try that, see +[enable the use of `RuntimeDefault` as the default seccomp profile for all workloads](#enable-the-use-of-runtimedefault-as-the-default-seccomp-profile-for-all-workloads) +before you continue. + +Once you have a kind configuration in place, create the kind cluster with +that configuration: + +```shell kind create cluster --config=kind.yaml ``` -Once the cluster is ready, identify the container running as the single node -cluster: +After the new Kubernetes cluster is ready, identify the Docker container running +as the single node cluster: -``` +```shell docker ps ``` You should see output indicating that a container is running with name -`kind-control-plane`. +`kind-control-plane`. The output is similar to: ``` CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES 6a96207fed4b kindest/node:v1.18.2 "/usr/local/bin/entr…" 27 seconds ago Up 24 seconds 127.0.0.1:42223->6443/tcp kind-control-plane ``` -If observing the filesystem of that container, one should see that the +If observing the filesystem of that container, you should see that the `profiles/` directory has been successfully loaded into the default seccomp path of the kubelet. Use `docker exec` to run a command in the Pod: -``` +```shell +# Change 6a96207fed4b to the container ID you saw from "docker ps" docker exec -it 6a96207fed4b ls /var/lib/kubelet/seccomp/profiles ``` @@ -165,22 +154,65 @@ docker exec -it 6a96207fed4b ls /var/lib/kubelet/seccomp/profiles audit.json fine-grained.json violation.json ``` +You have verified that these seccomp profiles are available to the kubelet +running within kind. + +## Enable the use of `RuntimeDefault` as the default seccomp profile for all workloads + +{{< feature-state state="alpha" for_k8s_version="v1.22" >}} + +`SeccompDefault` is an optional kubelet +[feature gate](/docs/reference/command-line-tools-reference/feature-gates) as +well as corresponding `--seccomp-default` +[command line flag](/docs/reference/command-line-tools-reference/kubelet). +Both have to be enabled simultaneously to use the feature. + +If enabled, the kubelet will use the `RuntimeDefault` seccomp profile by default, which is +defined by the container runtime, instead of using the `Unconfined` (seccomp disabled) mode. +The default profiles aim to provide a strong set +of security defaults while preserving the functionality of the workload. It is +possible that the default profiles differ between container runtimes and their +release versions, for example when comparing those from CRI-O and containerd. + +Some workloads may require a lower amount of syscall restrictions than others. +This means that they can fail during runtime even with the `RuntimeDefault` +profile. To mitigate such a failure, you can: + +- Run the workload explicitly as `Unconfined`. +- Disable the `SeccompDefault` feature for the nodes. Also making sure that + workloads get scheduled on nodes where the feature is disabled. +- Create a custom seccomp profile for the workload. + +If you were introducing this feature into production-like cluster, the Kubernetes project +recommends that you enable this feature gate on a subset of your nodes and then +test workload execution before rolling the change out cluster-wide. + +More detailed information about a possible upgrade and downgrade strategy can be +found in the [related Kubernetes Enhancement Proposal (KEP)](https://github.com/kubernetes/enhancements/tree/a70cc18/keps/sig-node/2413-seccomp-by-default#upgrade--downgrade-strategy). + +Since the feature is in alpha state it is disabled per default. To enable it, +pass the flags `--feature-gates=SeccompDefault=true --seccomp-default` to the +`kubelet` CLI or enable it via the [kubelet configuration +file](/docs/tasks/administer-cluster/kubelet-config-file/). To enable the +feature gate in [kind](https://kind.sigs.k8s.io), ensure that `kind` provides +the minimum required Kubernetes version and enables the `SeccompDefault` feature +[in the kind configuration](https://kind.sigs.k8s.io/docs/user/quick-start/#enable-feature-gates-in-your-cluster): + +```yaml +kind: Cluster +apiVersion: kind.x-k8s.io/v1alpha4 +featureGates: + SeccompDefault: true +``` + ## Create a Pod with a seccomp profile for syscall auditing To start off, apply the `audit.json` profile, which will log all syscalls of the process, to a new Pod. -Download the correct manifest for your Kubernetes version: +Here's a manifest for that Pod: -{{< tabs name="audit_pods" >}} -{{< tab name="v1.19 or Later (GA)" >}} {{< codenew file="pods/security/seccomp/ga/audit-pod.yaml" >}} -{{< /tab >}}} -{{{< tab name="Pre-v1.19 (deprecated)" >}} -{{< codenew file="pods/security/seccomp/alpha/audit-pod.yaml" >}} -{{< /tab >}} -{{< /tabs >}} -
{{< note >}} The functional support for the already deprecated seccomp annotations @@ -192,14 +224,14 @@ the native API fields in favor of the annotations. Create the Pod in the cluster: -``` -kubectl apply -f audit-pod.yaml +```shell +kubectl apply -f https://k8s.io/examples/pods/security/seccomp/ga/audit-pod.yaml ``` This profile does not restrict any syscalls, so the Pod should start successfully. -``` +```shell kubectl get pod/audit-pod ``` @@ -209,28 +241,31 @@ audit-pod 1/1 Running 0 30s ``` In order to be able to interact with this endpoint exposed by this -container,create a NodePort Service that allows access to the endpoint from -inside the kind control plane container. +container, create a NodePort {{< glossary_tooltip text="Services" term_id="service" >}} +that allows access to the endpoint from inside the kind control plane container. -``` -kubectl expose pod/audit-pod --type NodePort --port 5678 +```shell +kubectl expose pod audit-pod --type NodePort --port 5678 ``` Check what port the Service has been assigned on the node. -``` -kubectl get svc/audit-pod +```shell +kubectl get service audit-pod ``` +The output is similar to: ``` NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE audit-pod NodePort 10.111.36.142 5678:32373/TCP 72s ``` -Now you can `curl` the endpoint from inside the kind control plane container at -the port exposed by this Service. Use `docker exec` to run a command in the Pod: +Now you can use `curl` to access that endpoint from inside the kind control plane container, +at the port exposed by this Service. Use `docker exec` to run the `curl` command within the +container belonging to that control plane container: -``` +```shell +# Change 6a96207fed4b to the control plane container ID you saw from "docker ps" docker exec -it 6a96207fed4b curl localhost:32373 ``` @@ -243,13 +278,14 @@ Because this Pod is running in a local cluster, you should be able to see those in `/var/log/syslog`. Open up a new terminal window and `tail` the output for calls from `http-echo`: -``` +```shell tail -f /var/log/syslog | grep 'http-echo' ``` You should already see some logs of syscalls made by `http-echo`, and if you `curl` the endpoint in the control plane container you will see more written. +For example: ``` Jul 6 15:37:40 my-machine kernel: [369128.669452] audit: type=1326 audit(1594067860.484:14536): auid=4294967295 uid=0 gid=0 ses=4294967295 pid=29064 comm="http-echo" exe="/http-echo" sig=0 arch=c000003e syscall=51 compat=0 ip=0x46fe1f code=0x7ffc0000 Jul 6 15:37:40 my-machine kernel: [369128.669453] audit: type=1326 audit(1594067860.484:14537): auid=4294967295 uid=0 gid=0 ses=4294967295 pid=29064 comm="http-echo" exe="/http-echo" sig=0 arch=c000003e syscall=54 compat=0 ip=0x46fdba code=0x7ffc0000 @@ -268,9 +304,9 @@ for this container. Clean up that Pod and Service before moving to the next section: -``` -kubectl delete pod/audit-pod -kubectl delete svc/audit-pod +```shell +kubectl delete service audit-pod --wait +kubectl delete pod audit-pod --wait --now ``` ## Create Pod with seccomp Profile that Causes Violation @@ -278,27 +314,20 @@ kubectl delete svc/audit-pod For demonstration, apply a profile to the Pod that does not allow for any syscalls. -Download the correct manifest for your Kubernetes version: +The manifest for this demonstration is: -{{< tabs name="violation_pods" >}} -{{< tab name="v1.19 or Later (GA)" >}} {{< codenew file="pods/security/seccomp/ga/violation-pod.yaml" >}} -{{< /tab >}}} -{{{< tab name="Pre-v1.19 (deprecated)" >}} -{{< codenew file="pods/security/seccomp/alpha/violation-pod.yaml" >}} -{{< /tab >}} -{{< /tabs >}} -
-Create the Pod in the cluster: +Attempt to create the Pod in the cluster: -``` -kubectl apply -f violation-pod.yaml +```shell +kubectl apply -f https://k8s.io/examples/pods/security/seccomp/ga/violation-pod.yaml ``` +The Pod creates, but there is an issue. If you check the status of the Pod, you should see that it failed to start. -``` +```shell kubectl get pod/violation-pod ``` @@ -316,8 +345,8 @@ only the privileges they need. Clean up that Pod and Service before moving to the next section: ``` -kubectl delete pod/violation-pod -kubectl delete svc/violation-pod +kubectl delete service violation-pod --wait +kubectl delete pod violation-pod --wait --now ``` ## Create Pod with seccomp Profile that Only Allows Necessary Syscalls @@ -329,61 +358,56 @@ but explicitly allowing a set of syscalls in the `"action": "SCMP_ACT_ALLOW"` block. Ideally, the container will run successfully and you will see no messages sent to `syslog`. -Download the correct manifest for your Kubernetes version: +The manifest for this example is: -{{< tabs name="fine_pods" >}} -{{< tab name="v1.19 or Later (GA)" >}} {{< codenew file="pods/security/seccomp/ga/fine-pod.yaml" >}} -{{< /tab >}}} -{{{< tab name="Pre-v1.19 (deprecated)" >}} -{{< codenew file="pods/security/seccomp/alpha/fine-pod.yaml" >}} -{{< /tab >}} -{{< /tabs >}} -
Create the Pod in your cluster: +```shell +kubectl apply -f https://k8s.io/examples/pods/security/seccomp/ga/fine-pod.yaml ``` -kubectl apply -f fine-pod.yaml -``` - -The Pod should start successfully. -``` -kubectl get pod/fine-pod +```shell +kubectl get pod fine-pod ``` +The Pod should be showing as having started successfully: ``` NAME READY STATUS RESTARTS AGE fine-pod 1/1 Running 0 30s ``` -Open up a new terminal window and `tail` the output for calls from `http-echo`: +Open up a new terminal window and use `tail` to monitor for log entries that +mention calls from `http-echo`: -``` +```shell +# The log path on your computer might be different from "/var/log/syslog" tail -f /var/log/syslog | grep 'http-echo' ``` -Expose the Pod with a NodePort Service: +Next, expose the Pod with a NodePort Service: -``` -kubectl expose pod/fine-pod --type NodePort --port 5678 +```shell +kubectl expose pod fine-pod --type NodePort --port 5678 ``` Check what port the Service has been assigned on the node: -``` -kubectl get svc/fine-pod +```shell +kubectl get service fine-pod ``` +The output is similar to: ``` NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE fine-pod NodePort 10.111.36.142 5678:32373/TCP 72s ``` -`curl` the endpoint from inside the kind control plane container: +Use `curl` to access that endpoint from inside the kind control plane container: -``` +```shell +# Change 6a96207fed4b to the control plane container ID you saw from "docker ps" docker exec -it 6a96207fed4b curl localhost:32373 ``` @@ -391,7 +415,7 @@ docker exec -it 6a96207fed4b curl localhost:32373 just made some syscalls! ``` -You should see no output in the `syslog` because the profile allowed all +You should see no output in the `syslog`. This is because the profile allowed all necessary syscalls and specified that an error should occur if one outside of the list is invoked. This is an ideal situation from a security perspective, but required some effort in analyzing the program. It would be nice if there was a @@ -399,9 +423,9 @@ simple way to get closer to this security without requiring as much effort. Clean up that Pod and Service before moving to the next section: -``` -kubectl delete pod/fine-pod -kubectl delete svc/fine-pod +```shell +kubectl delete service fine-pod --wait +kubectl delete pod fine-pod --wait --now ``` ## Create Pod that uses the Container Runtime Default seccomp Profile @@ -411,23 +435,13 @@ or not. The defaults can easily be applied in Kubernetes by using the `runtime/default` annotation or setting the seccomp type in the security context of a pod or container to `RuntimeDefault`. -Download the correct manifest for your Kubernetes version: - -{{< tabs name="default_pods" >}} -{{< tab name="v1.19 or Later (GA)" >}} {{< codenew file="pods/security/seccomp/ga/default-pod.yaml" >}} -{{< /tab >}}} -{{{< tab name="Pre-v1.19 (deprecated)" >}} -{{< codenew file="pods/security/seccomp/alpha/default-pod.yaml" >}} -{{< /tab >}} -{{< /tabs >}} -
The default seccomp profile should provide adequate access for most workloads. ## {{% heading "whatsnext" %}} -Additional resources: +You can learn more about Linux seccomp: * [A seccomp Overview](https://lwn.net/Articles/656307/) * [Seccomp Security Profiles for Docker](https://docs.docker.com/engine/security/seccomp/) From 97a7bbcea8dd72bb5babb6f8eb2446f173667e6b Mon Sep 17 00:00:00 2001 From: Tim Bannister Date: Sat, 16 Oct 2021 13:01:36 +0100 Subject: [PATCH 07/68] Expand on runtime default part of seccomp tutorial --- content/en/docs/tutorials/clusters/seccomp.md | 36 ++++++++++++++++--- .../pods/security/seccomp/ga/default-pod.yaml | 6 ++-- 2 files changed, 34 insertions(+), 8 deletions(-) diff --git a/content/en/docs/tutorials/clusters/seccomp.md b/content/en/docs/tutorials/clusters/seccomp.md index af8cb9e2efbeb..e3705f5d38c88 100644 --- a/content/en/docs/tutorials/clusters/seccomp.md +++ b/content/en/docs/tutorials/clusters/seccomp.md @@ -344,7 +344,7 @@ only the privileges they need. Clean up that Pod and Service before moving to the next section: -``` +```shell kubectl delete service violation-pod --wait kubectl delete pod violation-pod --wait --now ``` @@ -431,13 +431,39 @@ kubectl delete pod fine-pod --wait --now ## Create Pod that uses the Container Runtime Default seccomp Profile Most container runtimes provide a sane set of default syscalls that are allowed -or not. The defaults can easily be applied in Kubernetes by using the -`runtime/default` annotation or setting the seccomp type in the security context -of a pod or container to `RuntimeDefault`. +or not. You can adopt these defaults for your workload by setting the seccomp +type in the security context of a pod or container to `RuntimeDefault`. + +{{< note >}} +If you have the `SeccompDefault` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/) enabled, then Pods use the `RuntimeDefault` seccomp profile whenever +no other seccomp profile is specified. Otherwise, the default is `Unconfined`. +{{< /note >}} + +Here's a manifest for a Pod that requests the `RuntimeDefault` seccomp profile +for all its containers: {{< codenew file="pods/security/seccomp/ga/default-pod.yaml" >}} -The default seccomp profile should provide adequate access for most workloads. +Create that Pod: +```shell +kubectl apply -f https://k8s.io/examples/pods/security/seccomp/ga/default-pod.yaml +``` + +```shell +kubectl get pod default-pod +``` + +The Pod should be showing as having started successfully: +``` +NAME READY STATUS RESTARTS AGE +default-pod 1/1 Running 0 20s +``` + +Finally, now that you saw that work OK, clean up: + +```shell +kubectl delete pod default-pod --wait --now +``` ## {{% heading "whatsnext" %}} diff --git a/content/en/examples/pods/security/seccomp/ga/default-pod.yaml b/content/en/examples/pods/security/seccomp/ga/default-pod.yaml index fbeec4c1676d3..b884ec5924221 100644 --- a/content/en/examples/pods/security/seccomp/ga/default-pod.yaml +++ b/content/en/examples/pods/security/seccomp/ga/default-pod.yaml @@ -1,9 +1,9 @@ apiVersion: v1 kind: Pod metadata: - name: audit-pod + name: default-pod labels: - app: audit-pod + app: default-pod spec: securityContext: seccompProfile: @@ -12,6 +12,6 @@ spec: - name: test-container image: hashicorp/http-echo:0.2.3 args: - - "-text=just made some syscalls!" + - "-text=just made some more syscalls!" securityContext: allowPrivilegeEscalation: false \ No newline at end of file From ee588f6d2badb3c0ccca204c848d85bd45497d57 Mon Sep 17 00:00:00 2001 From: Tim Bannister Date: Sat, 16 Oct 2021 12:24:32 +0100 Subject: [PATCH 08/68] Write headings in sentence case Other than page titles, headings should be sentence case --- content/en/docs/tutorials/clusters/seccomp.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/content/en/docs/tutorials/clusters/seccomp.md b/content/en/docs/tutorials/clusters/seccomp.md index e3705f5d38c88..a160e08542fb9 100644 --- a/content/en/docs/tutorials/clusters/seccomp.md +++ b/content/en/docs/tutorials/clusters/seccomp.md @@ -57,7 +57,7 @@ run as `Unconfined`. -## Create Seccomp Profiles +## Download example seccomp profiles {#download-profiles} The contents of these profiles will be explored later on, but for now go ahead and download them into a directory named `profiles/` so that they can be loaded @@ -91,7 +91,7 @@ audit.json fine-grained.json violation.json ``` -## Create a Local Kubernetes Cluster with kind +## Create a local Kubernetes cluster with kind For simplicity, [kind](https://kind.sigs.k8s.io/) can be used to create a single @@ -309,7 +309,7 @@ kubectl delete service audit-pod --wait kubectl delete pod audit-pod --wait --now ``` -## Create Pod with seccomp Profile that Causes Violation +## Create Pod with seccomp profile that causes violation For demonstration, apply a profile to the Pod that does not allow for any syscalls. @@ -349,7 +349,7 @@ kubectl delete service violation-pod --wait kubectl delete pod violation-pod --wait --now ``` -## Create Pod with seccomp Profile that Only Allows Necessary Syscalls +## Create Pod with seccomp profile that only allows necessary syscalls If you take a look at the `fine-pod.json`, you will notice some of the syscalls seen in the first example where the profile set `"defaultAction": @@ -428,7 +428,7 @@ kubectl delete service fine-pod --wait kubectl delete pod fine-pod --wait --now ``` -## Create Pod that uses the Container Runtime Default seccomp Profile +## Create Pod that uses the container runtime default seccomp profile Most container runtimes provide a sane set of default syscalls that are allowed or not. You can adopt these defaults for your workload by setting the seccomp From 5d5a2125c58c741259d37a9f1bc1dcfc22e66284 Mon Sep 17 00:00:00 2001 From: Tim Bannister Date: Sat, 16 Oct 2021 12:24:54 +0100 Subject: [PATCH 09/68] Use a glossary tooltip for "node" --- content/en/docs/tutorials/clusters/seccomp.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/tutorials/clusters/seccomp.md b/content/en/docs/tutorials/clusters/seccomp.md index a160e08542fb9..2d4ec69999574 100644 --- a/content/en/docs/tutorials/clusters/seccomp.md +++ b/content/en/docs/tutorials/clusters/seccomp.md @@ -17,7 +17,7 @@ Seccomp stands for secure computing mode and has been a feature of the Linux kernel since version 2.6.12. It can be used to sandbox the privileges of a process, restricting the calls it is able to make from userspace into the kernel. Kubernetes lets you automatically apply seccomp profiles loaded onto a -Node to your Pods and containers. +{{< glossary_tooltip text="node" term_id="node" >}} to your Pods and containers. Identifying the privileges required for your workloads can be difficult. In this tutorial, you will go through how to load seccomp profiles into a local From 11117310a52a86be8b023404c2a6dd5378ec197e Mon Sep 17 00:00:00 2001 From: Sahil Vazirani Date: Sun, 10 Oct 2021 23:09:52 -0700 Subject: [PATCH 10/68] GA TTLAfterFinish --- .../workloads/controllers/cron-jobs.md | 2 + .../workloads/controllers/ttlafterfinished.md | 51 ++++++++----------- .../feature-gates.md | 5 +- 3 files changed, 27 insertions(+), 31 deletions(-) diff --git a/content/en/docs/concepts/workloads/controllers/cron-jobs.md b/content/en/docs/concepts/workloads/controllers/cron-jobs.md index c6cd4d13367ff..95a58dfc83203 100644 --- a/content/en/docs/concepts/workloads/controllers/cron-jobs.md +++ b/content/en/docs/concepts/workloads/controllers/cron-jobs.md @@ -142,3 +142,5 @@ documents the format of CronJob `schedule` fields. For instructions on creating and working with cron jobs, and for an example of CronJob manifest, see [Running automated tasks with cron jobs](/docs/tasks/job/automated-tasks-with-cron-jobs). +For instructions to clean up failed or completed jobs automatically, see +[Clean up Jobs automatically](/docs/concepts/workloads/controllers/job/#clean-up-finished-jobs-automatically) diff --git a/content/en/docs/concepts/workloads/controllers/ttlafterfinished.md b/content/en/docs/concepts/workloads/controllers/ttlafterfinished.md index 266e72a79fd0f..a51c88602fcf6 100644 --- a/content/en/docs/concepts/workloads/controllers/ttlafterfinished.md +++ b/content/en/docs/concepts/workloads/controllers/ttlafterfinished.md @@ -1,75 +1,68 @@ --- reviewers: - janetkuo -title: TTL Controller for Finished Resources +title: Automatic Clean-up for Finished Jobs content_type: concept weight: 70 --- -{{< feature-state for_k8s_version="v1.21" state="beta" >}} +{{< feature-state for_k8s_version="v1.23" state="stable" >}} -The TTL controller provides a TTL (time to live) mechanism to limit the lifetime of resource -objects that have finished execution. TTL controller only handles -{{< glossary_tooltip text="Jobs" term_id="job" >}} for now, -and may be expanded to handle other resources that will finish execution, -such as Pods and custom resources. - -This feature is currently beta and enabled by default, and can be disabled via -[feature gate](/docs/reference/command-line-tools-reference/feature-gates/) -`TTLAfterFinished` in both kube-apiserver and kube-controller-manager. +TTL-after-finished {{}} provides a +TTL (time to live) mechanism to limit the lifetime of resource objects that +have finished execution. TTL controller only handles +{{< glossary_tooltip text="Jobs" term_id="job" >}}. -## TTL Controller +## TTL-after-finished Controller -The TTL controller only supports Jobs for now. A cluster operator can use this feature to clean +The TTL-after-finished controller is only supported for Jobs. A cluster operator can use this feature to clean up finished Jobs (either `Complete` or `Failed`) automatically by specifying the `.spec.ttlSecondsAfterFinished` field of a Job, as in this [example](/docs/concepts/workloads/controllers/job/#clean-up-finished-jobs-automatically). -The TTL controller will assume that a resource is eligible to be cleaned up -TTL seconds after the resource has finished, in other words, when the TTL has expired. When the -TTL controller cleans up a resource, it will delete it cascadingly, that is to say it will delete -its dependent objects together with it. Note that when the resource is deleted, +The TTL-after-finished controller will assume that a job is eligible to be cleaned up +TTL seconds after the job has finished, in other words, when the TTL has expired. When the +TTL-after-finished controller cleans up a job, it will delete it cascadingly, that is to say it will delete +its dependent objects together with it. Note that when the job is deleted, its lifecycle guarantees, such as finalizers, will be honored. The TTL seconds can be set at any time. Here are some examples for setting the `.spec.ttlSecondsAfterFinished` field of a Job: -* Specify this field in the resource manifest, so that a Job can be cleaned up +* Specify this field in the job manifest, so that a Job can be cleaned up automatically some time after it finishes. -* Set this field of existing, already finished resources, to adopt this new +* Set this field of existing, already finished jobs, to adopt this new feature. * Use a [mutating admission webhook](/docs/reference/access-authn-authz/extensible-admission-controllers/#admission-webhooks) - to set this field dynamically at resource creation time. Cluster administrators can - use this to enforce a TTL policy for finished resources. + to set this field dynamically at job creation time. Cluster administrators can + use this to enforce a TTL policy for finished jobs. * Use a [mutating admission webhook](/docs/reference/access-authn-authz/extensible-admission-controllers/#admission-webhooks) - to set this field dynamically after the resource has finished, and choose - different TTL values based on resource status, labels, etc. + to set this field dynamically after the job has finished, and choose + different TTL values based on job status, labels, etc. ## Caveat ### Updating TTL Seconds Note that the TTL period, e.g. `.spec.ttlSecondsAfterFinished` field of Jobs, -can be modified after the resource is created or has finished. However, once the +can be modified after the job is created or has finished. However, once the Job becomes eligible to be deleted (when the TTL has expired), the system won't guarantee that the Jobs will be kept, even if an update to extend the TTL returns a successful API response. ### Time Skew -Because TTL controller uses timestamps stored in the Kubernetes resources to +Because TTL-after-finished controller uses timestamps stored in the Kubernetes jobs to determine whether the TTL has expired or not, this feature is sensitive to time -skew in the cluster, which may cause TTL controller to clean up resource objects +skew in the cluster, which may cause TTL-after-finish controller to clean up job objects at the wrong time. -In Kubernetes, it's required to run NTP on all nodes -(see [#6159](https://github.com/kubernetes/kubernetes/issues/6159#issuecomment-93844058)) -to avoid time skew. Clocks aren't always correct, but the difference should be +Clocks aren't always correct, but the difference should be very small. Please be aware of this risk when setting a non-zero TTL. diff --git a/content/en/docs/reference/command-line-tools-reference/feature-gates.md b/content/en/docs/reference/command-line-tools-reference/feature-gates.md index d6390296599a8..b3921172378c4 100644 --- a/content/en/docs/reference/command-line-tools-reference/feature-gates.md +++ b/content/en/docs/reference/command-line-tools-reference/feature-gates.md @@ -190,8 +190,6 @@ different Kubernetes components. | `StorageVersionHash` | `true` | Beta | 1.15 | | | `SuspendJob` | `false` | Alpha | 1.21 | 1.21 | | `SuspendJob` | `true` | Beta | 1.22 | | -| `TTLAfterFinished` | `false` | Alpha | 1.12 | 1.20 | -| `TTLAfterFinished` | `true` | Beta | 1.21 | | | `TopologyAwareHints` | `false` | Alpha | 1.21 | | | `TopologyManager` | `false` | Alpha | 1.16 | 1.17 | | `TopologyManager` | `true` | Beta | 1.18 | | @@ -439,6 +437,9 @@ different Kubernetes components. | `SupportPodPidsLimit` | `true` | GA | 1.20 | - | | `Sysctls` | `true` | Beta | 1.11 | 1.20 | | `Sysctls` | `true` | GA | 1.21 | | +| `TTLAfterFinished` | `false` | Alpha | 1.12 | 1.20 | +| `TTLAfterFinished` | `true` | Beta | 1.21 | 1.22 | +| `TTLAfterFinished` | `true` | GA | 1.23 | - | | `TaintBasedEvictions` | `false` | Alpha | 1.6 | 1.12 | | `TaintBasedEvictions` | `true` | Beta | 1.13 | 1.17 | | `TaintBasedEvictions` | `true` | GA | 1.18 | - | From 26280ee0c1104bb475d90beed2bf4937ff72fed3 Mon Sep 17 00:00:00 2001 From: Jonathan Dobson Date: Wed, 27 Oct 2021 12:02:08 -0600 Subject: [PATCH 11/68] Move CSIVolumeFSGroupPolicy to GA --- .../reference/command-line-tools-reference/feature-gates.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/content/en/docs/reference/command-line-tools-reference/feature-gates.md b/content/en/docs/reference/command-line-tools-reference/feature-gates.md index 91aa118fa293d..fab4148736448 100644 --- a/content/en/docs/reference/command-line-tools-reference/feature-gates.md +++ b/content/en/docs/reference/command-line-tools-reference/feature-gates.md @@ -83,8 +83,6 @@ different Kubernetes components. | `CSIMigrationvSphere` | `false` | Beta | 1.19 | | | `CSIStorageCapacity` | `false` | Alpha | 1.19 | 1.20 | | `CSIStorageCapacity` | `true` | Beta | 1.21 | | -| `CSIVolumeFSGroupPolicy` | `false` | Alpha | 1.19 | 1.19 | -| `CSIVolumeFSGroupPolicy` | `true` | Beta | 1.20 | | | `CSIVolumeHealth` | `false` | Alpha | 1.21 | | | `CSRDuration` | `true` | Beta | 1.22 | | | `ConfigurableFSGroupPolicy` | `false` | Alpha | 1.18 | 1.19 | @@ -255,6 +253,9 @@ different Kubernetes components. | `CSIServiceAccountToken` | `false` | Alpha | 1.20 | 1.20 | | `CSIServiceAccountToken` | `true` | Beta | 1.21 | 1.21 | | `CSIServiceAccountToken` | `true` | GA | 1.22 | | +| `CSIVolumeFSGroupPolicy` | `false` | Alpha | 1.19 | 1.19 | +| `CSIVolumeFSGroupPolicy` | `true` | Beta | 1.20 | 1.22 | +| `CSIVolumeFSGroupPolicy` | `true` | GA | 1.23 | | | `CronJobControllerV2` | `false` | Alpha | 1.20 | 1.20 | | `CronJobControllerV2` | `true` | Beta | 1.21 | 1.21 | | `CronJobControllerV2` | `true` | GA | 1.22 | - | From e50ce5f26925db442559ee4d307deb01c322424f Mon Sep 17 00:00:00 2001 From: Jordan Liggitt Date: Mon, 25 Oct 2021 14:13:24 -0400 Subject: [PATCH 12/68] PodSecurity: runAsUser --- .../security/pod-security-standards.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/content/en/docs/concepts/security/pod-security-standards.md b/content/en/docs/concepts/security/pod-security-standards.md index f3b43344bf8ab..62e8943479902 100644 --- a/content/en/docs/concepts/security/pod-security-standards.md +++ b/content/en/docs/concepts/security/pod-security-standards.md @@ -373,6 +373,24 @@ fail validation. + + Running as Non-root user (v1.23+) + +

Containers must not set runAsUser to 0

+

Restricted Fields

+
    +
  • spec.securityContext.runAsUser
  • +
  • spec.containers[*].securityContext.runAsUser
  • +
  • spec.initContainers[*].securityContext.runAsUser
  • +
  • spec.ephemeralContainers[*].securityContext.runAsUser
  • +
+

Allowed Values

+
    +
  • any non-zero value
  • +
  • undefined/null
  • +
+ + Non-root groups (optional) From dabf80ae5629da135758d0e742f8d032e32069e3 Mon Sep 17 00:00:00 2001 From: Ayushman Date: Tue, 2 Nov 2021 20:07:15 +0530 Subject: [PATCH 13/68] Added Note for Deprecation of Flexvolume flexVolume Signed-off-by: Ayushman --- content/en/docs/concepts/storage/volumes.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/content/en/docs/concepts/storage/volumes.md b/content/en/docs/concepts/storage/volumes.md index 56694dee66c32..e8f65df8cc251 100644 --- a/content/en/docs/concepts/storage/volumes.md +++ b/content/en/docs/concepts/storage/volumes.md @@ -1381,6 +1381,10 @@ plugin path on each node and in some cases the control plane nodes as well. Pods interact with FlexVolume drivers through the `flexvolume` in-tree volume plugin. For more details, see the [FlexVolume](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-storage/flexvolume.md) examples. +{{< note >}} +FlexVolume is deprecated starting v1.23. Out-of-tree CSI driver is the recommended way to write volume driver in Kubernetes. Maintainers of FlexVolume driver should implement a CSI Driver and move users of FlexVolume to CSI. Users of FlexVolume should move their workloads to CSI Driver. +{{< /note >}} + ## Mount propagation Mount propagation allows for sharing volumes mounted by a container to From 14a003cb3b42967f6c516353c6a1f36989d54925 Mon Sep 17 00:00:00 2001 From: ahg-g <40361897+ahg-g@users.noreply.github.com> Date: Wed, 10 Nov 2021 07:43:27 -0500 Subject: [PATCH 14/68] add docs for JobMutableNodeSchedulingDirectives (#30390) --- .../concepts/workloads/controllers/job.md | 31 ++++++++++++++++++- .../feature-gates.md | 3 ++ 2 files changed, 33 insertions(+), 1 deletion(-) diff --git a/content/en/docs/concepts/workloads/controllers/job.md b/content/en/docs/concepts/workloads/controllers/job.md index 54a4104c5e920..7ab98f6fbadf4 100644 --- a/content/en/docs/concepts/workloads/controllers/job.md +++ b/content/en/docs/concepts/workloads/controllers/job.md @@ -417,7 +417,10 @@ version of Kubernetes you're using](/docs/home/supported-doc-versions/). When a Job is created, the Job controller will immediately begin creating Pods to satisfy the Job's requirements and will continue to do so until the Job is complete. However, you may want to temporarily suspend a Job's execution and -resume it later. To suspend a Job, you can update the `.spec.suspend` field of +resume it later, or start Jobs in suspended state and have a custom controller +decide later when to start them. + +To suspend a Job, you can update the `.spec.suspend` field of the Job to true; later, when you want to resume it again, update it to false. Creating a Job with `.spec.suspend` set to true will create it in the suspended state. @@ -503,6 +506,32 @@ directly a result of toggling the `.spec.suspend` field. In the time between these two events, we see that no Pods were created, but Pod creation restarted as soon as the Job was resumed. +### Mutable Scheduling Directives + +{{< feature-state for_k8s_version="v1.23" state="beta" >}} + +{{< note >}} +In order to use this behavior, you must enable the `JobMutableNodeSchedulingDirectives` +[feature gate](/docs/reference/command-line-tools-reference/feature-gates/) +on the [API server](/docs/reference/command-line-tools-reference/kube-apiserver/). +It is enabled by default. +{{< /note >}} + +In most cases a parallel job will want the pods to run with constraints, +like all in the same zone, or all either on GPU model x or y but not a mix of both. + +The [suspend](#suspending-a-job) field is the first step towards achieving those semantics. Suspend allows a +custom queue controller to decide when a job should start; However, once a job is unsuspended, +a custom queue controller has no influence on where the pods of a job will actually land. + +This feature allows updating a Job's scheduling directives before it starts, which gives custom queue +controllers the ability to influence pod placement while at the same time offloading actual +pod-to-node assignment to kube-scheduler. This is allowed only for suspended Jobs that have never +been unsuspended before. + +The fields in a Job's pod template that can be updated are node affinity, node selector, +tolerations, labels and annotations. + ### Specifying your own Pod selector Normally, when you create a Job object, you do not specify `.spec.selector`. diff --git a/content/en/docs/reference/command-line-tools-reference/feature-gates.md b/content/en/docs/reference/command-line-tools-reference/feature-gates.md index fab4148736448..8b2d4dd18e062 100644 --- a/content/en/docs/reference/command-line-tools-reference/feature-gates.md +++ b/content/en/docs/reference/command-line-tools-reference/feature-gates.md @@ -133,6 +133,7 @@ different Kubernetes components. | `InTreePluginvSphereUnregister` | `false` | Alpha | 1.21 | | | `IPv6DualStack` | `false` | Alpha | 1.15 | 1.20 | | `IPv6DualStack` | `true` | Beta | 1.21 | | +| `JobMutableNodeSchedulingDirectives` | `true` | Beta | 1.23 | | | `JobTrackingWithFinalizers` | `false` | Alpha | 1.22 | | | `KubeletCredentialProviders` | `false` | Alpha | 1.20 | | | `KubeletInUserNamespace` | `false` | Alpha | 1.22 | | @@ -794,6 +795,8 @@ Each feature gate is designed for enabling/disabling a specific feature: Initializers admission plugin. - `IPv6DualStack`: Enable [dual stack](/docs/concepts/services-networking/dual-stack/) support for IPv6. +- `JobMutableNodeSchedulingDirectives`: Allows updating node scheduling directives in + the pod template of [Job](/docs/concepts/workloads/controllers/job). - `JobTrackingWithFinalizers`: Enables tracking [Job](/docs/concepts/workloads/controllers/job) completions without relying on Pods remaining in the cluster indefinitely. The Job controller uses Pod finalizers and a field in the Job status to keep From 575b742e0a800328ed357331d56d95f133b5f857 Mon Sep 17 00:00:00 2001 From: Aldo Culquicondor Date: Tue, 9 Nov 2021 14:15:45 -0500 Subject: [PATCH 15/68] Graduate JobTrackingWithFinalizers to beta --- content/en/docs/concepts/workloads/controllers/job.md | 9 +++++---- .../command-line-tools-reference/feature-gates.md | 3 ++- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/content/en/docs/concepts/workloads/controllers/job.md b/content/en/docs/concepts/workloads/controllers/job.md index 7ab98f6fbadf4..33bb415570521 100644 --- a/content/en/docs/concepts/workloads/controllers/job.md +++ b/content/en/docs/concepts/workloads/controllers/job.md @@ -601,18 +601,19 @@ mismatch. ### Job tracking with finalizers -{{< feature-state for_k8s_version="v1.22" state="alpha" >}} +{{< feature-state for_k8s_version="v1.23" state="beta" >}} {{< note >}} In order to use this behavior, you must enable the `JobTrackingWithFinalizers` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/) on the [API server](/docs/reference/command-line-tools-reference/kube-apiserver/) and the [controller manager](/docs/reference/command-line-tools-reference/kube-controller-manager/). -It is disabled by default. +It is enabled by default. When enabled, the control plane tracks new Jobs using the behavior described -below. Existing Jobs are unaffected. As a user, the only difference you would -see is that the control plane tracking of Job completion is more accurate. +below. Jobs created before the feature was enabled are unaffected. As a user, +the only difference you would see is that the control plane tracking of Job +completion is more accurate. {{< /note >}} When this feature isn't enabled, the Job {{< glossary_tooltip term_id="controller" >}} diff --git a/content/en/docs/reference/command-line-tools-reference/feature-gates.md b/content/en/docs/reference/command-line-tools-reference/feature-gates.md index 8b2d4dd18e062..8cc2ed9cbc6a3 100644 --- a/content/en/docs/reference/command-line-tools-reference/feature-gates.md +++ b/content/en/docs/reference/command-line-tools-reference/feature-gates.md @@ -134,7 +134,8 @@ different Kubernetes components. | `IPv6DualStack` | `false` | Alpha | 1.15 | 1.20 | | `IPv6DualStack` | `true` | Beta | 1.21 | | | `JobMutableNodeSchedulingDirectives` | `true` | Beta | 1.23 | | -| `JobTrackingWithFinalizers` | `false` | Alpha | 1.22 | | +| `JobTrackingWithFinalizers` | `false` | Alpha | 1.22 | 1.22 | +| `JobTrackingWithFinalizers` | `true` | Beta | 1.23 | | | `KubeletCredentialProviders` | `false` | Alpha | 1.20 | | | `KubeletInUserNamespace` | `false` | Alpha | 1.22 | | | `KubeletPodResourcesGetAllocatable` | `false` | Alpha | 1.21 | | From 4b7784728a24bc5c8dcb71c89fcc11e432b3e163 Mon Sep 17 00:00:00 2001 From: Jordan Liggitt Date: Wed, 3 Nov 2021 17:43:43 -0400 Subject: [PATCH 16/68] PodSecurity beta updates --- .../security/pod-security-admission.md | 37 +++++++++++--- .../admission-controllers.md | 2 +- .../feature-gates.md | 3 +- .../enforce-standards-admission-controller.md | 48 ++++++++++++++++++- .../enforce-standards-namespace-labels.md | 2 +- .../migrate-from-psp.md | 2 +- 6 files changed, 82 insertions(+), 12 deletions(-) diff --git a/content/en/docs/concepts/security/pod-security-admission.md b/content/en/docs/concepts/security/pod-security-admission.md index a1c87767c9be9..933dc62940876 100644 --- a/content/en/docs/concepts/security/pod-security-admission.md +++ b/content/en/docs/concepts/security/pod-security-admission.md @@ -13,13 +13,13 @@ min-kubernetes-server-version: v1.22 -{{< feature-state for_k8s_version="v1.22" state="alpha" >}} +{{< feature-state for_k8s_version="v1.23" state="beta" >}} The Kubernetes [Pod Security Standards](/docs/concepts/security/pod-security-standards/) define different isolation levels for Pods. These standards let you define how you want to restrict the behavior of pods in a clear, consistent fashion. -As an Alpha feature, Kubernetes offers a built-in _Pod Security_ {{< glossary_tooltip +As an Beta feature, Kubernetes offers a built-in _Pod Security_ {{< glossary_tooltip text="admission controller" term_id="admission-controller" >}}, the successor to [PodSecurityPolicies](/docs/concepts/policy/pod-security-policy/). Pod security restrictions are applied at the {{< glossary_tooltip text="namespace" term_id="namespace" >}} level when pods @@ -32,15 +32,40 @@ The PodSecurityPolicy API is deprecated and will be -## Enabling the Alpha feature +## Enabling the `PodSecurity` admission plugin -Setting pod security controls by namespace is an alpha feature. You must enable the `PodSecurity` -[feature gate](/docs/reference/command-line-tools-reference/feature-gates/) in order to use it. +In v1.23, the `PodSecurity` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/) +is a Beta feature and is enabled by default. + +In v1.22, the `PodSecurity` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/) +is an Alpha feature and must be enabled in `kube-apiserver` in order to use the built-in admission plugin. ```shell --feature-gates="...,PodSecurity=true" ``` +## Alternative: installing the `PodSecurity` admission webhook + +For environments where the built-in `PodSecurity` admission plugin cannot be used, +either because the cluster is older than v1.22, or the `PodSecurity` feature cannot be enabled, +the `PodSecurity` admission logic is also available as a Beta [validating admission webhook](https://git.k8s.io/pod-security-admission/webhook). + +A pre-built container image, certificate generation scripts, and example manifests +are available at [https://git.k8s.io/pod-security-admission/webhook](https://git.k8s.io/pod-security-admission/webhook). + +To install: +```shell +git clone git@github.com:kubernetes/pod-security-admission.git +cd pod-security-admission/webhook +make certs +kubectl apply -k . +``` + +{{< note >}} +The generated certificate is valid for 2 years. Before it expires, +regenerate the certificate or remove the webhook in favor of the built-in admission plugin. +{{< /note >}} + ## Pod Security levels Pod Security admission places requirements on a Pod's [Security @@ -52,7 +77,7 @@ page for an in-depth look at those requirements. ## Pod Security Admission labels for namespaces -Provided that you have enabled this feature, you can configure namespaces to define the admission +Once the feature is enabled or the webhook is installed, you can configure namespaces to define the admission control mode you want to use for pod security in each namespace. Kubernetes defines a set of {{< glossary_tooltip term_id="label" text="labels" >}} that you can set to define which of the predefined Pod Security Standard levels you want to use for a namespace. The label you select diff --git a/content/en/docs/reference/access-authn-authz/admission-controllers.md b/content/en/docs/reference/access-authn-authz/admission-controllers.md index 0461c09f53229..7957ff7a4fcfa 100644 --- a/content/en/docs/reference/access-authn-authz/admission-controllers.md +++ b/content/en/docs/reference/access-authn-authz/admission-controllers.md @@ -698,7 +698,7 @@ admission plugin, which allows preventing pods from running on specifically tain ### PodSecurity {#podsecurity} -{{< feature-state for_k8s_version="v1.22" state="alpha" >}} +{{< feature-state for_k8s_version="v1.23" state="beta" >}} This is the replacement for the deprecated [PodSecurityPolicy](#podsecuritypolicy) admission controller defined in the next section. This admission controller acts on creation and modification of the pod and diff --git a/content/en/docs/reference/command-line-tools-reference/feature-gates.md b/content/en/docs/reference/command-line-tools-reference/feature-gates.md index 91aa118fa293d..dc369aee3d037 100644 --- a/content/en/docs/reference/command-line-tools-reference/feature-gates.md +++ b/content/en/docs/reference/command-line-tools-reference/feature-gates.md @@ -159,7 +159,8 @@ different Kubernetes components. | `PodAffinityNamespaceSelector` | `true` | Beta | 1.22 | | | `PodOverhead` | `false` | Alpha | 1.16 | 1.17 | | `PodOverhead` | `true` | Beta | 1.18 | | -| `PodSecurity` | `false` | Alpha | 1.22 | | +| `PodSecurity` | `false` | Alpha | 1.22 | 1.22 | +| `PodSecurity` | `true` | Beta | 1.23 | | | `PreferNominatedNode` | `false` | Alpha | 1.21 | 1.21 | | `PreferNominatedNode` | `true` | Beta | 1.22 | | | `ProbeTerminationGracePeriod` | `false` | Alpha | 1.21 | 1.21 | diff --git a/content/en/docs/tasks/configure-pod-container/enforce-standards-admission-controller.md b/content/en/docs/tasks/configure-pod-container/enforce-standards-admission-controller.md index ef8206b1b6a9b..c2f9fae3f7c1e 100644 --- a/content/en/docs/tasks/configure-pod-container/enforce-standards-admission-controller.md +++ b/content/en/docs/tasks/configure-pod-container/enforce-standards-admission-controller.md @@ -15,10 +15,52 @@ You can configure this admission controller to set cluster-wide defaults and [ex {{% version-check %}} -- Enable the `PodSecurity` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-alpha-or-beta-features). +- Ensure the `PodSecurity` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-alpha-or-beta-features) is enabled. ## Configure the Admission Controller +{{< tabs name="PodSecurityConfiguration_example_1" >}} +{{% tab name="pod-security.admission.config.k8s.io/v1beta1" %}} +```yaml +apiVersion: apiserver.config.k8s.io/v1 +kind: AdmissionConfiguration +plugins: +- name: PodSecurity + configuration: + apiVersion: pod-security.admission.config.k8s.io/v1beta1 + kind: PodSecurityConfiguration + # Defaults applied when a mode label is not set. + # + # Level label values must be one of: + # - "privileged" (default) + # - "baseline" + # - "restricted" + # + # Version label values must be one of: + # - "latest" (default) + # - specific version like "v{{< skew latestVersion >}}" + defaults: + enforce: "privileged" + enforce-version: "latest" + audit: "privileged" + audit-version: "latest" + warn: "privileged" + warn-version: "latest" + exemptions: + # Array of authenticated usernames to exempt. + usernames: [] + # Array of runtime class names to exempt. + runtimeClassNames: [] + # Array of namespaces to exempt. + namespaces: [] +``` + +{{< note >}} +v1beta1 configuration requires v1.23+. For v1.22, use v1alpha1. +{{< /note >}} + +{{% /tab %}} +{{% tab name="pod-security.admission.config.k8s.io/v1alpha1" %}} ```yaml apiVersion: apiserver.config.k8s.io/v1 kind: AdmissionConfiguration @@ -51,4 +93,6 @@ plugins: runtimeClassNames: [] # Array of namespaces to exempt. namespaces: [] -``` \ No newline at end of file +``` +{{% /tab %}} +{{< /tabs >}} diff --git a/content/en/docs/tasks/configure-pod-container/enforce-standards-namespace-labels.md b/content/en/docs/tasks/configure-pod-container/enforce-standards-namespace-labels.md index 9a4c3a44ed4c9..121f9b15e7c54 100644 --- a/content/en/docs/tasks/configure-pod-container/enforce-standards-namespace-labels.md +++ b/content/en/docs/tasks/configure-pod-container/enforce-standards-namespace-labels.md @@ -13,7 +13,7 @@ Namespaces can be labeled to enforce the [Pod Security Standards](/docs/concepts {{% version-check %}} -- Enable the `PodSecurity` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-alpha-or-beta-features). +- Ensure the `PodSecurity` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-alpha-or-beta-features) is enabled. ## Requiring the `baseline` Pod Security Standard with namespace labels diff --git a/content/en/docs/tasks/configure-pod-container/migrate-from-psp.md b/content/en/docs/tasks/configure-pod-container/migrate-from-psp.md index f0ea2d02dfb02..adc8225e23894 100644 --- a/content/en/docs/tasks/configure-pod-container/migrate-from-psp.md +++ b/content/en/docs/tasks/configure-pod-container/migrate-from-psp.md @@ -17,7 +17,7 @@ admission controller. This can be done effectively using a combination of dry-ru {{% version-check %}} -- Enable the `PodSecurity` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-alpha-or-beta-features). +- Ensure the `PodSecurity` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-alpha-or-beta-features) is enabled. From 1e0796c4e4ae671329b1a5728d1e3af05b060c89 Mon Sep 17 00:00:00 2001 From: Cheng Xing Date: Wed, 10 Nov 2021 16:57:29 -0800 Subject: [PATCH 17/68] Delegate FSGroup to CSI beta --- .../en/docs/tasks/configure-pod-container/security-context.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/tasks/configure-pod-container/security-context.md b/content/en/docs/tasks/configure-pod-container/security-context.md index 56bcc0f3f9211..ef9cbf620086b 100644 --- a/content/en/docs/tasks/configure-pod-container/security-context.md +++ b/content/en/docs/tasks/configure-pod-container/security-context.md @@ -186,7 +186,7 @@ and [`emptydir`](/docs/concepts/storage/volumes/#emptydir). ## Delegating volume permission and ownership change to CSI driver -{{< feature-state for_k8s_version="v1.22" state="alpha" >}} +{{< feature-state for_k8s_version="v1.23" state="beta" >}} If you deploy a [Container Storage Interface (CSI)](https://github.com/container-storage-interface/spec/blob/master/spec.md) driver which supports the `VOLUME_MOUNT_GROUP` `NodeServiceCapability`, the From 4729b75ffb04203c2f1173c97fafdd194f217c0c Mon Sep 17 00:00:00 2001 From: Harry Bagdi Date: Thu, 11 Nov 2021 08:51:52 -0800 Subject: [PATCH 18/68] graduate IngressClassNamespacedParams to GA --- content/en/docs/concepts/services-networking/ingress.md | 2 +- .../reference/command-line-tools-reference/feature-gates.md | 5 +++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/content/en/docs/concepts/services-networking/ingress.md b/content/en/docs/concepts/services-networking/ingress.md index 6879b998db224..fbeb5289fb27d 100644 --- a/content/en/docs/concepts/services-networking/ingress.md +++ b/content/en/docs/concepts/services-networking/ingress.md @@ -224,7 +224,7 @@ reference additional implementation-specific configuration for this class. #### Namespace-scoped parameters -{{< feature-state for_k8s_version="v1.22" state="beta" >}} +{{< feature-state for_k8s_version="v1.23" state="stable" >}} `Parameters` field has a `scope` and `namespace` field that can be used to reference a namespace-specific resource for configuration of an Ingress class. diff --git a/content/en/docs/reference/command-line-tools-reference/feature-gates.md b/content/en/docs/reference/command-line-tools-reference/feature-gates.md index fab4148736448..a3ff10133e777 100644 --- a/content/en/docs/reference/command-line-tools-reference/feature-gates.md +++ b/content/en/docs/reference/command-line-tools-reference/feature-gates.md @@ -123,8 +123,6 @@ different Kubernetes components. | `HPAScaleToZero` | `false` | Alpha | 1.16 | | | `IndexedJob` | `false` | Alpha | 1.21 | 1.21 | | `IndexedJob` | `true` | Beta | 1.22 | | -| `IngressClassNamespacedParams` | `false` | Alpha | 1.21 | 1.21 | -| `IngressClassNamespacedParams` | `true` | Beta | 1.22 | | | `InTreePluginAWSUnregister` | `false` | Alpha | 1.21 | | | `InTreePluginAzureDiskUnregister` | `false` | Alpha | 1.21 | | | `InTreePluginAzureFileUnregister` | `false` | Alpha | 1.21 | | @@ -324,6 +322,9 @@ different Kubernetes components. | `ImmutableEphemeralVolumes` | `false` | Alpha | 1.18 | 1.18 | | `ImmutableEphemeralVolumes` | `true` | Beta | 1.19 | 1.20 | | `ImmutableEphemeralVolumes` | `true` | GA | 1.21 | | +| `IngressClassNamespacedParams` | `false` | Alpha | 1.21 | 1.21 | +| `IngressClassNamespacedParams` | `true` | Beta | 1.22 | 1.22 | +| `IngressClassNamespacedParams` | `true` | GA | 1.23 | - | | `Initializers` | `false` | Alpha | 1.7 | 1.13 | | `Initializers` | - | Deprecated | 1.14 | - | | `KubeletConfigFile` | `false` | Alpha | 1.8 | 1.9 | From 65bceb18762f0c182dbbc50d9dfbeb478fcccc03 Mon Sep 17 00:00:00 2001 From: Patrick Ohly Date: Thu, 4 Nov 2021 15:01:34 +0100 Subject: [PATCH 19/68] generic ephemeral volumes: document graduation to GA --- content/en/docs/concepts/storage/ephemeral-volumes.md | 7 +------ .../command-line-tools-reference/feature-gates.md | 5 +++-- 2 files changed, 4 insertions(+), 8 deletions(-) diff --git a/content/en/docs/concepts/storage/ephemeral-volumes.md b/content/en/docs/concepts/storage/ephemeral-volumes.md index 1e811fb82a40a..5c9f9b21d318c 100644 --- a/content/en/docs/concepts/storage/ephemeral-volumes.md +++ b/content/en/docs/concepts/storage/ephemeral-volumes.md @@ -130,10 +130,7 @@ As a cluster administrator, you can use a [PodSecurityPolicy](/docs/concepts/pol ### Generic ephemeral volumes -{{< feature-state for_k8s_version="v1.21" state="beta" >}} - -This feature requires the `GenericEphemeralVolume` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/) to be -enabled. Because this is a beta feature, it is enabled by default. +{{< feature-state for_k8s_version="v1.23" state="stable" >}} Generic ephemeral volumes are similar to `emptyDir` volumes in the sense that they provide a per-pod directory for scratch data that is @@ -245,7 +242,6 @@ PVCs indirectly if they can create Pods, even if they do not have permission to create PVCs directly. Cluster administrators must be aware of this. If this does not fit their security model, they have two choices: -- Explicitly disable the feature through the feature gate. - Use a [Pod Security Policy](/docs/concepts/policy/pod-security-policy/) where the `volumes` list does not contain the `ephemeral` volume type @@ -274,4 +270,3 @@ See [local ephemeral storage](/docs/concepts/configuration/manage-resources-cont - For more information on the design, see the [Generic ephemeral inline volumes KEP](https://github.com/kubernetes/enhancements/blob/master/keps/sig-storage/1698-generic-ephemeral-volumes/README.md). -- For more information on further development of this feature, see the [enhancement tracking issue #1698](https://github.com/kubernetes/enhancements/issues/1698). diff --git a/content/en/docs/reference/command-line-tools-reference/feature-gates.md b/content/en/docs/reference/command-line-tools-reference/feature-gates.md index 91aa118fa293d..01b2310638f49 100644 --- a/content/en/docs/reference/command-line-tools-reference/feature-gates.md +++ b/content/en/docs/reference/command-line-tools-reference/feature-gates.md @@ -117,8 +117,6 @@ different Kubernetes components. | `ExpandPersistentVolumes` | `false` | Alpha | 1.8 | 1.10 | | `ExpandPersistentVolumes` | `true` | Beta | 1.11 | | | `ExperimentalHostUserNamespaceDefaulting` | `false` | Beta | 1.5 | | -| `GenericEphemeralVolume` | `false` | Alpha | 1.19 | 1.20 | -| `GenericEphemeralVolume` | `true` | Beta | 1.21 | | | `GracefulNodeShutdown` | `false` | Alpha | 1.20 | 1.20 | | `GracefulNodeShutdown` | `true` | Beta | 1.21 | | | `HPAContainerMetrics` | `false` | Alpha | 1.20 | | @@ -309,6 +307,9 @@ different Kubernetes components. | `ExternalPolicyForExternalIP` | `true` | GA | 1.18 | - | | `GCERegionalPersistentDisk` | `true` | Beta | 1.10 | 1.12 | | `GCERegionalPersistentDisk` | `true` | GA | 1.13 | - | +| `GenericEphemeralVolume` | `false` | Alpha | 1.19 | 1.20 | +| `GenericEphemeralVolume` | `true` | Beta | 1.21 | 1.22 | +| `GenericEphemeralVolume` | `true` | GA | 1.23 | - | | `HugePageStorageMediumSize` | `false` | Alpha | 1.18 | 1.18 | | `HugePageStorageMediumSize` | `true` | Beta | 1.19 | 1.21 | | `HugePageStorageMediumSize` | `true` | GA | 1.22 | - | From 771ee157a9d396284f1030d6b3a5de09b86e151e Mon Sep 17 00:00:00 2001 From: Lee Verberne Date: Thu, 30 Sep 2021 22:25:58 +0200 Subject: [PATCH 20/68] Promote EphemeralContainers to beta --- .../concepts/workloads/pods/ephemeral-containers.md | 11 +---------- .../command-line-tools-reference/feature-gates.md | 3 ++- .../debug-application-cluster/debug-running-pod.md | 8 +------- 3 files changed, 4 insertions(+), 18 deletions(-) diff --git a/content/en/docs/concepts/workloads/pods/ephemeral-containers.md b/content/en/docs/concepts/workloads/pods/ephemeral-containers.md index c26a63b183b32..d32511da2868e 100644 --- a/content/en/docs/concepts/workloads/pods/ephemeral-containers.md +++ b/content/en/docs/concepts/workloads/pods/ephemeral-containers.md @@ -9,22 +9,13 @@ weight: 80 -{{< feature-state state="alpha" for_k8s_version="v1.22" >}} +{{< feature-state state="beta" for_k8s_version="v1.23" >}} This page provides an overview of ephemeral containers: a special type of container that runs temporarily in an existing {{< glossary_tooltip term_id="pod" >}} to accomplish user-initiated actions such as troubleshooting. You use ephemeral containers to inspect services rather than to build applications. -{{< warning >}} -Ephemeral containers are in alpha state and are not suitable for production -clusters. In accordance with the [Kubernetes Deprecation Policy]( -/docs/reference/using-api/deprecation-policy/), this alpha feature could change -significantly in the future or be removed entirely. -{{< /warning >}} - - - ## Understanding ephemeral containers diff --git a/content/en/docs/reference/command-line-tools-reference/feature-gates.md b/content/en/docs/reference/command-line-tools-reference/feature-gates.md index 63eba752de109..91eb1a0f6b5ec 100644 --- a/content/en/docs/reference/command-line-tools-reference/feature-gates.md +++ b/content/en/docs/reference/command-line-tools-reference/feature-gates.md @@ -106,7 +106,8 @@ different Kubernetes components. | `EfficientWatchResumption` | `true` | Beta | 1.21 | | | `EndpointSliceTerminatingCondition` | `false` | Alpha | 1.20 | 1.21 | | `EndpointSliceTerminatingCondition` | `true` | Beta | 1.22 | | -| `EphemeralContainers` | `false` | Alpha | 1.16 | | +| `EphemeralContainers` | `false` | Alpha | 1.16 | 1.22 | +| `EphemeralContainers` | `true` | Beta | 1.23 | | | `ExpandCSIVolumes` | `false` | Alpha | 1.14 | 1.15 | | `ExpandCSIVolumes` | `true` | Beta | 1.16 | | | `ExpandedDNSConfig` | `false` | Alpha | 1.22 | | diff --git a/content/en/docs/tasks/debug-application-cluster/debug-running-pod.md b/content/en/docs/tasks/debug-application-cluster/debug-running-pod.md index 6009a76341103..9653ff05ef1ff 100644 --- a/content/en/docs/tasks/debug-application-cluster/debug-running-pod.md +++ b/content/en/docs/tasks/debug-application-cluster/debug-running-pod.md @@ -73,7 +73,7 @@ For more details, see [Get a Shell to a Running Container]( ## Debugging with an ephemeral debug container {#ephemeral-container} -{{< feature-state state="alpha" for_k8s_version="v1.22" >}} +{{< feature-state state="beta" for_k8s_version="v1.23" >}} {{< glossary_tooltip text="Ephemeral containers" term_id="ephemeral-container" >}} are useful for interactive troubleshooting when `kubectl exec` is insufficient @@ -83,12 +83,6 @@ https://github.com/GoogleContainerTools/distroless). ### Example debugging using ephemeral containers {#ephemeral-container-example} -{{< note >}} -The examples in this section require the `EphemeralContainers` [feature gate]( -/docs/reference/command-line-tools-reference/feature-gates/) enabled in your -cluster and `kubectl` version v1.22 or later. -{{< /note >}} - You can use the `kubectl debug` command to add ephemeral containers to a running Pod. First, create a pod for the example: From 8d6da018576a9a50acfcdb9f451021d5c1a000dc Mon Sep 17 00:00:00 2001 From: Swati Sehgal Date: Fri, 21 May 2021 00:39:30 +0100 Subject: [PATCH 21/68] podresource-api: Graduate GetAllocatableResources to Beta Also, explicitly clarify the behavior of GetAllocatableResources The explanation that GetAllocatableResources can be used to obtain available resources on the node can be misinterpretted as an API that is used to obtain free/unallocated resources on a node. This PR adds additional text to clarify that this API endpoint only returns allocatable resources which are resources exposed to kubelet as defined here: https://kubernetes.io/docs/tasks/administer-cluster/reserve-compute-resources/#node-allocatable. Signed-off-by: Swati Sehgal --- .../compute-storage-net/device-plugins.md | 25 +++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/content/en/docs/concepts/extend-kubernetes/compute-storage-net/device-plugins.md b/content/en/docs/concepts/extend-kubernetes/compute-storage-net/device-plugins.md index 868d8d56e8ff6..6e766a86d6ed1 100644 --- a/content/en/docs/concepts/extend-kubernetes/compute-storage-net/device-plugins.md +++ b/content/en/docs/concepts/extend-kubernetes/compute-storage-net/device-plugins.md @@ -197,6 +197,8 @@ service PodResourcesLister { } ``` +### `List` gRPC endpoint {#grpc-endpoint-list} + The `List` endpoint provides information on resources of running pods, with details such as the id of exclusively allocated CPUs, device id as it was reported by device plugins and id of the NUMA node where these devices are allocated. Also, for NUMA-based machines, it contains the information about memory and hugepages reserved for a container. @@ -247,9 +249,25 @@ message ContainerDevices { } ``` +### `GetAllocatableResources` gRPC endpoint {#grpc-endpoint-getallocatableresources} + +{{< feature-state state="beta" for_k8s_version="v1.23" >}} + GetAllocatableResources provides information on resources initially available on the worker node. It provides more information than kubelet exports to APIServer. +{{< note >}} +`GetAllocatableResources` should only be used to evaluate [allocatable](/docs/tasks/administer-cluster/reserve-compute-resources/#node-allocatable) +resources on a node. If the goal is to evaluate free/unallocated resources it should be used in +conjunction with the List() endpoint. The result obtained by `GetAllocatableResources` would remain +the same unless the underlying resources exposed to kubelet change. This happens rarely but when +it does (for example: hotplug/hotunplug, device health changes), client is expected to call +`GetAlloctableResources` endpoint. +However, calling `GetAllocatableResources` endpoint is not sufficient in case of cpu and/or memory +update and Kubelet needs to be restarted to reflect the correct resource capacity and allocatable. +{{< /note >}} + + ```gRPC // AllocatableResourcesResponses contains informations about all the devices known by the kubelet message AllocatableResourcesResponse { @@ -259,6 +277,13 @@ message AllocatableResourcesResponse { } ``` +Starting from Kubernetes v1.23, the `GetAllocatableResources` is enabled by default. +You can disable it by turning off the +`KubeletPodResourcesGetAllocatable` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/). + +Preceding Kubernetes v1.23, to enable this feature `kubelet` must be started with the following flag: + +`--feature-gates=KubeletPodResourcesGetAllocatable=true` `ContainerDevices` do expose the topology information declaring to which NUMA cells the device is affine. The NUMA cells are identified using a opaque integer ID, which value is consistent to what device From c7231c8d6d0045bba24ea475f44e5daa3525df3c Mon Sep 17 00:00:00 2001 From: Swati Sehgal Date: Tue, 5 Oct 2021 21:08:43 +0100 Subject: [PATCH 22/68] Explicitly state that GetCpuIds returns exclusive cpus Based on the discussion here: https://github.com/kubernetes/kubernetes/pull/97415#discussion_r722548437 we explictly state that the GetCpuIds returned for a ContainerResource in the ListPodResourcesResponse represent only exclusively allocated CPUs. In order to evaluate the CPUs corresponding to the shared pool, List endpoint should be used in conjunction with GetAllocatableResources endpoint. We highlight the steps that the client needs to take evaluate this. Signed-off-by: Swati Sehgal --- .../compute-storage-net/device-plugins.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/content/en/docs/concepts/extend-kubernetes/compute-storage-net/device-plugins.md b/content/en/docs/concepts/extend-kubernetes/compute-storage-net/device-plugins.md index 6e766a86d6ed1..f14f78b13b6dc 100644 --- a/content/en/docs/concepts/extend-kubernetes/compute-storage-net/device-plugins.md +++ b/content/en/docs/concepts/extend-kubernetes/compute-storage-net/device-plugins.md @@ -248,6 +248,15 @@ message ContainerDevices { TopologyInfo topology = 3; } ``` +{{< note >}} +cpu_ids in the `ContainerResources` in the `List` endpoint correspond to exclusive CPUs allocated +to a partilar container. If the goal is to evaluate CPUs that belong to the shared pool, the `List` +endpoint needs to be used in conjunction with the `GetAllocatableResources` endpoint as explained +below: +1. Call `GetAllocatableResources` to get a list of all the allocatable CPUs +2. Call `GetCpuIds` on all `ContainerResources` in the system +3. Subtract out all of the CPUs from the `GetCpuIds` calls from the `GetAllocatableResources` call +{{< /note >}} ### `GetAllocatableResources` gRPC endpoint {#grpc-endpoint-getallocatableresources} From 378fc570b1863c0494e1541724f21eb49d287872 Mon Sep 17 00:00:00 2001 From: Kevin Klues Date: Sat, 13 Nov 2021 17:06:40 +0100 Subject: [PATCH 23/68] Add description of distribute-cpus-across-numa CPUManager policy option Signed-off-by: Kevin Klues --- .../cpu-management-policies.md | 26 ++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/content/en/docs/tasks/administer-cluster/cpu-management-policies.md b/content/en/docs/tasks/administer-cluster/cpu-management-policies.md index 9eb7d7febb3d7..41fbe77cb039f 100644 --- a/content/en/docs/tasks/administer-cluster/cpu-management-policies.md +++ b/content/en/docs/tasks/administer-cluster/cpu-management-policies.md @@ -218,8 +218,11 @@ equal to one. The `nginx` container is granted 2 exclusive CPUs. #### Static policy options +The following policy options exist for the static `CPUManager` policy: +* `full-pcpus-only` (beta, visible by default) +* `distribute-cpus-across-numa` (alpha, hidden by default) + If the `full-pcpus-only` policy option is specified, the static policy will always allocate full physical cores. -You can enable this option by adding `full-pcups-only=true` to the CPUManager policy options. By default, without this option, the static policy allocates CPUs using a topology-aware best-fit allocation. On SMT enabled systems, the policy can allocate individual virtual cores, which correspond to hardware threads. This can lead to different containers sharing the same physical cores; this behaviour in turn contributes @@ -227,3 +230,24 @@ to the [noisy neighbours problem](https://en.wikipedia.org/wiki/Cloud_computing_ With the option enabled, the pod will be admitted by the kubelet only if the CPU request of all its containers can be fulfilled by allocating full physical cores. If the pod does not pass the admission, it will be put in Failed state with the message `SMTAlignmentError`. + +If the `distribute-cpus-across-numa`policy option is specified, the static +policy will evenly distribute CPUs across NUMA nodes in cases where more than +one NUMA node is required to satisfy the allocation. +By default, the `CPUManager` will pack CPUs onto one NUMA node until it is +filled, with any remaining CPUs simply spilling over to the next NUMA node. +This can cause undesired bottlenecks in parallel code relying on barriers (and +similar synchronization primitivies), as this type of code tends to run only as +fast as its slowest worker (which is slowed down by the fact that fewer CPUs +are available on at least one NUMA node). +By distributing CPUs evenly across NUMA nodes, application developers can more +easily ensure that no single worker suffers from NUMA effects more than any +other, improving the overall performance of these types of applications. + +The `full-pcpus-only` option can be enabled by adding `full-pcups-only=true` to +the CPUManager policy options. +Likewise, the `distribute-cpus-across-numa` option can be enabled by adding +`distribute-cpus-across-numa=true` to the CPUManager policy options. +When both are set, they are "additive" in the sense that CPUs will be +distributed across NUMA nodes in chunks of full-pcpus rather than individual +cores. From c3073161f7f28b401dbdea1e5a97106aa9ad28f2 Mon Sep 17 00:00:00 2001 From: Patrick Ohly Date: Tue, 16 Nov 2021 16:13:35 +0100 Subject: [PATCH 24/68] logging: structured logging, klog deprecation This is primarily the docs PR for - alpha: https://github.com/kubernetes/enhancements/issues/2845 - beta: https://github.com/kubernetes/enhancements/issues/1602 But as it touches the file, it also updates the examples and explanations to reflect some recent observations. --- .../cluster-administration/system-logs.md | 68 +++++++++++++++++-- 1 file changed, 63 insertions(+), 5 deletions(-) diff --git a/content/en/docs/concepts/cluster-administration/system-logs.md b/content/en/docs/concepts/cluster-administration/system-logs.md index 0466837356023..58f123a1c87da 100644 --- a/content/en/docs/concepts/cluster-administration/system-logs.md +++ b/content/en/docs/concepts/cluster-administration/system-logs.md @@ -22,14 +22,62 @@ generates log messages for the Kubernetes system components. For more information about klog configuration, see the [Command line tool reference](/docs/reference/command-line-tools-reference/). -An example of the klog native format: +Kubernetes is in the process of simplifying logging in its components. The +following klog command line flags [are +deprecated](https://github.com/kubernetes/enhancements/tree/master/keps/sig-instrumentation/2845-deprecate-klog-specific-flags-in-k8s-components) +starting with Kubernetes 1.23 and will be removed in a future release: + +- `--add-dir-header` +- `--alsologtostderr` +- `--log-backtrace-at` +- `--log-dir` +- `--log-file` +- `--log-file-max-size` +- `--logtostderr` +- `--one-output` +- `--skip-headers` +- `--skip-log-headers` +- `--stderrthreshold` + +Output will always be written to stderr, regardless of the output +format. Output redirection is expected to be handled by the component which +invokes a Kubernetes component. This can be a POSIX shell or a tool like +systemd. + +In some cases, for example a distroless container or a Windows system service, +those options are not available. Then the +[`kube-log-runner`](https://github.com/kubernetes/kubernetes/blob/d2a8a81639fcff8d1221b900f66d28361a170654/staging/src/k8s.io/component-base/logs/kube-log-runner/README.md) +binary can be used as wrapper around a Kubernetes component to redirect +output. A prebuilt binary is included in several Kubernetes base images under +its traditional name as `/go-runner` and as `kube-log-runner` in server and +node release archives. + +This table shows how `kube-log-runner` invocations correspond to shell redirection: + +| Usage | POSIX shell (such as bash) | `kube-log-runner ` | +| -----------------------------------------|----------------------------|-------------------------------------------------------------| +| Merge stderr and stdout, write to stdout | `2>&1` | `kube-log-runner` (default behavior) | +| Redirect both into log file | `1>>/tmp/log 2>&1` | `kube-log-runner -log-file=/tmp/log` | +| Copy into log file and to stdout | `2>&1 \| tee -a /tmp/log` | `kube-log-runner -log-file=/tmp/log -also-stdout` | +| Redirect only stdout into log file | `>/tmp/log` | `kube-log-runner -log-file=/tmp/log -redirect-stderr=false` | + +### Klog output + +An example of the traditional klog native format: ``` I1025 00:15:15.525108 1 httplog.go:79] GET /api/v1/namespaces/kube-system/pods/metrics-server-v0.3.1-57c75779f-9p8wg: (1.512ms) 200 [pod_nanny/v0.0.0 (linux/amd64) kubernetes/$Format 10.56.1.19:51756] ``` +The message string may contain line breaks: +``` +I1025 00:15:15.525108 1 example.go:79] This is a message +which has a line break. +``` + + ### Structured Logging -{{< feature-state for_k8s_version="v1.19" state="alpha" >}} +{{< feature-state for_k8s_version="v1.23" state="beta" >}} {{< warning >}} Migration to structured log messages is an ongoing process. Not all log messages are structured in this version. When parsing log files, you must also handle unstructured log messages. @@ -38,9 +86,11 @@ Log formatting and value serialization are subject to change. {{< /warning>}} Structured logging introduces a uniform structure in log messages allowing for programmatic extraction of information. You can store and process structured logs with less effort and cost. -New message format is backward compatible and enabled by default. +The code which generates a log message determines whether it uses the traditional unstructured klog output +or structured logging. -Format of structured logs: +The default formatting of structured log messages is as text, with a format that +is backward compatible with traditional klog: ```ini "" ="" ="" ... @@ -52,6 +102,13 @@ Example: I1025 00:15:15.525108 1 controller_utils.go:116] "Pod status updated" pod="kube-system/kubedns" status="ready" ``` +Strings are quoted. Other values are formatted with +[`%+v`](https://pkg.go.dev/fmt#hdr-Printing), which may cause log messages to +continue on the next line [depending on the data](https://github.com/kubernetes/kubernetes/issues/106428). +``` +I1025 00:15:15.525108 1 example.go:116] "Example" data="This is text with a line break\nand \"quotation marks\"." someInt=1 someFloat=0.1 someStruct={StringField: First line, +second line.} +``` ### JSON log format @@ -82,7 +139,7 @@ Example of JSON log format (pretty printed): Keys with special meaning: * `ts` - timestamp as Unix time (required, float) -* `v` - verbosity (required, int, default 0) +* `v` - verbosity (only for info and not for error messages, int) * `err` - error string (optional, string) * `msg` - message (required, string) @@ -139,4 +196,5 @@ The `logrotate` tool rotates logs daily, or once the log size is greater than 10 * Read about the [Kubernetes Logging Architecture](/docs/concepts/cluster-administration/logging/) * Read about [Structured Logging](https://github.com/kubernetes/enhancements/tree/master/keps/sig-instrumentation/1602-structured-logging) +* Read about [deprecation of klog flags](https://github.com/kubernetes/enhancements/tree/master/keps/sig-instrumentation/2845-deprecate-klog-specific-flags-in-k8s-components) * Read about the [Conventions for logging severity](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-instrumentation/logging.md) From 2474ff93aad946c158cec46477601963b2dcda26 Mon Sep 17 00:00:00 2001 From: Rob Scott Date: Wed, 17 Nov 2021 11:21:54 -0800 Subject: [PATCH 25/68] Updating Topology Aware Hints docs for 1.23 --- .../service-traffic-policy.md | 2 +- .../topology-aware-hints.md | 6 +-- .../feature-gates.md | 3 +- .../enabling-topology-aware-hints.md | 40 ------------------- 4 files changed, 5 insertions(+), 46 deletions(-) delete mode 100644 content/en/docs/tasks/administer-cluster/enabling-topology-aware-hints.md diff --git a/content/en/docs/concepts/services-networking/service-traffic-policy.md b/content/en/docs/concepts/services-networking/service-traffic-policy.md index fb55a3d833e8a..0a62cb49348c7 100644 --- a/content/en/docs/concepts/services-networking/service-traffic-policy.md +++ b/content/en/docs/concepts/services-networking/service-traffic-policy.md @@ -68,6 +68,6 @@ When the [feature gate](/docs/reference/command-line-tools-reference/feature-gat ## {{% heading "whatsnext" %}} -* Read about [enabling Topology Aware Hints](/docs/tasks/administer-cluster/enabling-topology-aware-hints) +* Read about [Topology Aware Hints](/docs/concepts/services-networking/topology-aware-hints) * Read about [Service External Traffic Policy](/docs/tasks/access-application-cluster/create-external-load-balancer/#preserving-the-client-source-ip) * Read [Connecting Applications with Services](/docs/concepts/services-networking/connect-applications-service/) diff --git a/content/en/docs/concepts/services-networking/topology-aware-hints.md b/content/en/docs/concepts/services-networking/topology-aware-hints.md index f471caff6b24d..d07a75d9234f2 100644 --- a/content/en/docs/concepts/services-networking/topology-aware-hints.md +++ b/content/en/docs/concepts/services-networking/topology-aware-hints.md @@ -9,7 +9,7 @@ weight: 45 -{{< feature-state for_k8s_version="v1.21" state="alpha" >}} +{{< feature-state for_k8s_version="v1.23" state="beta" >}} _Topology Aware Hints_ enable topology aware routing by including suggestions for how clients should consume endpoints. This approach adds metadata to enable @@ -35,8 +35,7 @@ can then consume those hints, and use them to influence how traffic to is routed ## Using Topology Aware Hints -If you have [enabled](/docs/tasks/administer-cluster/enabling-topology-aware-hints) the -overall feature, you can activate Topology Aware Hints for a Service by setting the +You can activate Topology Aware Hints for a Service by setting the `service.kubernetes.io/topology-aware-hints` annotation to `auto`. This tells the EndpointSlice controller to set topology hints if it is deemed safe. Importantly, this does not guarantee that hints will always be set. @@ -156,5 +155,4 @@ zone. ## {{% heading "whatsnext" %}} -* Read about [enabling Topology Aware Hints](/docs/tasks/administer-cluster/enabling-topology-aware-hints/) * Read [Connecting Applications with Services](/docs/concepts/services-networking/connect-applications-service/) diff --git a/content/en/docs/reference/command-line-tools-reference/feature-gates.md b/content/en/docs/reference/command-line-tools-reference/feature-gates.md index 63eba752de109..67c1ac569c223 100644 --- a/content/en/docs/reference/command-line-tools-reference/feature-gates.md +++ b/content/en/docs/reference/command-line-tools-reference/feature-gates.md @@ -186,7 +186,8 @@ different Kubernetes components. | `StorageVersionHash` | `true` | Beta | 1.15 | | | `SuspendJob` | `false` | Alpha | 1.21 | 1.21 | | `SuspendJob` | `true` | Beta | 1.22 | | -| `TopologyAwareHints` | `false` | Alpha | 1.21 | | +| `TopologyAwareHints` | `false` | Alpha | 1.21 | 1.22 | +| `TopologyAwareHints` | `true` | Beta | 1.23 | | | `TopologyManager` | `false` | Alpha | 1.16 | 1.17 | | `TopologyManager` | `true` | Beta | 1.18 | | | `VolumeCapacityPriority` | `false` | Alpha | 1.21 | - | diff --git a/content/en/docs/tasks/administer-cluster/enabling-topology-aware-hints.md b/content/en/docs/tasks/administer-cluster/enabling-topology-aware-hints.md deleted file mode 100644 index dadc653f4e196..0000000000000 --- a/content/en/docs/tasks/administer-cluster/enabling-topology-aware-hints.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -reviewers: -- robscott -title: Enabling Topology Aware Hints -content_type: task -min-kubernetes-server-version: 1.21 ---- - - -{{< feature-state for_k8s_version="v1.21" state="alpha" >}} - -_Topology Aware Hints_ enable topology aware routing with topology hints -included in {{< glossary_tooltip text="EndpointSlices" term_id="endpoint-slice" >}}. -This approach tries to keep traffic close to where it originated from; -you might do this to reduce costs, or to improve network performance. - -## {{% heading "prerequisites" %}} - - {{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} - -The following prerequisite is needed in order to enable topology aware hints: - -* Configure the {{< glossary_tooltip text="kube-proxy" term_id="kube-proxy" >}} to run in - iptables mode or IPVS mode -* Ensure that you have not disabled EndpointSlices - -## Enable Topology Aware Hints - -To enable service topology hints, enable the `TopologyAwareHints` [feature -gate](/docs/reference/command-line-tools-reference/feature-gates/) for the -kube-apiserver, kube-controller-manager, and kube-proxy: - -``` ---feature-gates="TopologyAwareHints=true" -``` - -## {{% heading "whatsnext" %}} - -* Read about [Topology Aware Hints](/docs/concepts/services-networking/topology-aware-hints) for Services -* Read [Connecting Applications with Services](/docs/concepts/services-networking/connect-applications-service/) From a209e3d65eac600521b33f9091b6263703127432 Mon Sep 17 00:00:00 2001 From: Bridget Kromhout Date: Fri, 13 Aug 2021 17:08:22 -0500 Subject: [PATCH 26/68] Dual-stack to stable in 1.23 Co-Authored-By: Tim Bannister --- .../cluster-administration/networking.md | 2 +- .../services-networking/dual-stack.md | 11 +++------- .../feature-gates.md | 5 +++-- .../tools/kubeadm/dual-stack-support.md | 22 +++++-------------- .../docs/tasks/network/validate-dual-stack.md | 5 ++++- 5 files changed, 16 insertions(+), 29 deletions(-) diff --git a/content/en/docs/concepts/cluster-administration/networking.md b/content/en/docs/concepts/cluster-administration/networking.md index da9aeed0bad01..b9759799dc05e 100644 --- a/content/en/docs/concepts/cluster-administration/networking.md +++ b/content/en/docs/concepts/cluster-administration/networking.md @@ -64,7 +64,7 @@ This means that containers within a `Pod` can all reach each other's ports on usage, but this is no different from processes in a VM. This is called the "IP-per-pod" model. -How this is implemented is a detail of the particular container runtime in use. +How this is implemented is a detail of the particular container runtime in use. Likewise, the networking option you choose may support [dual-stack IPv4/IPv6 networking](/docs/concepts/services-networking/dual-stack/); implementations vary. It is possible to request ports on the `Node` itself which forward to your `Pod` (called host ports), but this is a very niche operation. How that forwarding is diff --git a/content/en/docs/concepts/services-networking/dual-stack.md b/content/en/docs/concepts/services-networking/dual-stack.md index a85226beed05c..b7ea673621c0d 100644 --- a/content/en/docs/concepts/services-networking/dual-stack.md +++ b/content/en/docs/concepts/services-networking/dual-stack.md @@ -16,7 +16,7 @@ weight: 70 -{{< feature-state for_k8s_version="v1.21" state="beta" >}} +{{< feature-state for_k8s_version="v1.23" state="stable" >}} IPv4/IPv6 dual-stack networking enables the allocation of both IPv4 and IPv6 addresses to {{< glossary_tooltip text="Pods" term_id="pod" >}} and {{< glossary_tooltip text="Services" term_id="service" >}}. @@ -47,8 +47,6 @@ The following prerequisites are needed in order to utilize IPv4/IPv6 dual-stack ## Configure IPv4/IPv6 dual-stack -To use IPv4/IPv6 dual-stack, ensure the `IPv6DualStack` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/) is enabled for the relevant components of your cluster. (Starting in 1.21, IPv4/IPv6 dual-stack defaults to enabled.) - To configure IPv4/IPv6 dual-stack, set dual-stack cluster network assignments: * kube-apiserver: @@ -65,9 +63,6 @@ An example of an IPv4 CIDR: `10.244.0.0/16` (though you would supply your own ad An example of an IPv6 CIDR: `fdXY:IJKL:MNOP:15::/64` (this shows the format but is not a valid address - see [RFC 4193](https://tools.ietf.org/html/rfc4193)) -Starting in 1.21, IPv4/IPv6 dual-stack defaults to enabled. -You can disable it when necessary by specifying `--feature-gates="IPv6DualStack=false"` -on the kube-apiserver, kube-controller-manager, kubelet, and kube-proxy command line. {{< /note >}} ## Services @@ -81,7 +76,7 @@ set the `.spec.ipFamilyPolicy` field to one of the following values: * `SingleStack`: Single-stack service. The control plane allocates a cluster IP for the Service, using the first configured service cluster IP range. * `PreferDualStack`: - * Allocates IPv4 and IPv6 cluster IPs for the Service. (If the cluster has `--feature-gates="IPv6DualStack=false"`, this setting follows the same behavior as `SingleStack`.) + * Allocates IPv4 and IPv6 cluster IPs for the Service. * `RequireDualStack`: Allocates Service `.spec.ClusterIPs` from both IPv4 and IPv6 address ranges. * Selects the `.spec.ClusterIP` from the list of `.spec.ClusterIPs` based on the address family of the first element in the `.spec.ipFamilies` array. @@ -124,7 +119,7 @@ These examples demonstrate the behavior of various dual-stack Service configurat #### Dual-stack defaults on existing Services -These examples demonstrate the default behavior when dual-stack is newly enabled on a cluster where Services already exist. (Upgrading an existing cluster to 1.21 will enable dual-stack unless `--feature-gates="IPv6DualStack=false"` is set.) +These examples demonstrate the default behavior when dual-stack is newly enabled on a cluster where Services already exist. (Upgrading an existing cluster to 1.21 or beyond will enable dual-stack.) 1. When dual-stack is enabled on a cluster, existing Services (whether `IPv4` or `IPv6`) are configured by the control plane to set `.spec.ipFamilyPolicy` to `SingleStack` and set `.spec.ipFamilies` to the address family of the existing Service. The existing Service cluster IP will be stored in `.spec.ClusterIPs`. diff --git a/content/en/docs/reference/command-line-tools-reference/feature-gates.md b/content/en/docs/reference/command-line-tools-reference/feature-gates.md index 63eba752de109..f74a78bb4c511 100644 --- a/content/en/docs/reference/command-line-tools-reference/feature-gates.md +++ b/content/en/docs/reference/command-line-tools-reference/feature-gates.md @@ -127,8 +127,6 @@ different Kubernetes components. | `InTreePluginGCEUnregister` | `false` | Alpha | 1.21 | | | `InTreePluginOpenStackUnregister` | `false` | Alpha | 1.21 | | | `InTreePluginvSphereUnregister` | `false` | Alpha | 1.21 | | -| `IPv6DualStack` | `false` | Alpha | 1.15 | 1.20 | -| `IPv6DualStack` | `true` | Beta | 1.21 | | | `JobMutableNodeSchedulingDirectives` | `true` | Beta | 1.23 | | | `JobTrackingWithFinalizers` | `false` | Alpha | 1.22 | 1.22 | | `JobTrackingWithFinalizers` | `true` | Beta | 1.23 | | @@ -331,6 +329,9 @@ different Kubernetes components. | `IngressClassNamespacedParams` | `true` | GA | 1.23 | - | | `Initializers` | `false` | Alpha | 1.7 | 1.13 | | `Initializers` | - | Deprecated | 1.14 | - | +| `IPv6DualStack` | `false` | Alpha | 1.15 | 1.20 | +| `IPv6DualStack` | `true` | Beta | 1.21 | 1.22 | +| `IPv6DualStack` | `true` | GA | 1.23 | - | | `KubeletConfigFile` | `false` | Alpha | 1.8 | 1.9 | | `KubeletConfigFile` | - | Deprecated | 1.10 | - | | `KubeletPluginsWatcher` | `false` | Alpha | 1.11 | 1.11 | diff --git a/content/en/docs/setup/production-environment/tools/kubeadm/dual-stack-support.md b/content/en/docs/setup/production-environment/tools/kubeadm/dual-stack-support.md index 283f3348749e3..f2d250c296fba 100644 --- a/content/en/docs/setup/production-environment/tools/kubeadm/dual-stack-support.md +++ b/content/en/docs/setup/production-environment/tools/kubeadm/dual-stack-support.md @@ -7,9 +7,9 @@ min-kubernetes-server-version: 1.21 -{{< feature-state for_k8s_version="v1.21" state="beta" >}} +{{< feature-state for_k8s_version="v1.23" state="stable" >}} -Your Kubernetes cluster can run in [dual-stack](/docs/concepts/services-networking/dual-stack/) networking mode, which means that cluster networking lets you use either address family. In a dual-stack cluster, the control plane can assign both an IPv4 address and an IPv6 address to a single {{< glossary_tooltip text="Pod" term_id="pod" >}} or a {{< glossary_tooltip text="Service" term_id="service" >}}. +Your Kubernetes cluster includes [dual-stack](/docs/concepts/services-networking/dual-stack/) networking, which means that cluster networking lets you use either address family. In a cluster, the control plane can assign both an IPv4 address and an IPv6 address to a single {{< glossary_tooltip text="Pod" term_id="pod" >}} or a {{< glossary_tooltip text="Service" term_id="service" >}}. @@ -28,10 +28,8 @@ The size of the IP address allocations should be suitable for the number of Pods Services that you are planning to run. {{< note >}} -If you are upgrading an existing cluster then, by default, the `kubeadm upgrade` command -changes the [feature gate](/docs/reference/command-line-tools-reference/feature-gates/) -`IPv6DualStack` to `true` if that is not already enabled. -However, `kubeadm` does not support making modifications to the pod IP address range +If you are upgrading an existing cluster with the `kubeadm upgrade` command, +`kubeadm` does not support making modifications to the pod IP address range (“cluster CIDR”) nor to the cluster's Service address range (“Service CIDR”). {{< /note >}} @@ -51,8 +49,6 @@ To make things clearer, here is an example kubeadm [configuration file](https:// --- apiVersion: kubeadm.k8s.io/v1beta3 kind: ClusterConfiguration -featureGates: - IPv6DualStack: true networking: podSubnet: 10.244.0.0/16,2001:db8:42:0::/56 serviceSubnet: 10.96.0.0/16,2001:db8:42:1::/112 @@ -132,23 +128,15 @@ kubeadm join --config=kubeadm-config.yaml ### Create a single-stack cluster {{< note >}} -Enabling the dual-stack feature doesn't mean that you need to use dual-stack addressing. +Dual-stack support doesn't mean that you need to use dual-stack addressing. You can deploy a single-stack cluster that has the dual-stack networking feature enabled. {{< /note >}} -In 1.21 the `IPv6DualStack` feature is Beta and the feature gate is defaulted to `true`. To disable the feature you must configure the feature gate to `false`. Note that once the feature is GA, the feature gate will be removed. - -```shell -kubeadm init --feature-gates IPv6DualStack=false -``` - To make things more clear, here is an example kubeadm [configuration file](https://pkg.go.dev/k8s.io/kubernetes/cmd/kubeadm/app/apis/kubeadm/v1beta3) `kubeadm-config.yaml` for the single-stack control plane node. ```yaml apiVersion: kubeadm.k8s.io/v1beta3 kind: ClusterConfiguration -featureGates: - IPv6DualStack: false networking: podSubnet: 10.244.0.0/16 serviceSubnet: 10.96.0.0/16 diff --git a/content/en/docs/tasks/network/validate-dual-stack.md b/content/en/docs/tasks/network/validate-dual-stack.md index 717bac27ad188..549c60b003d47 100644 --- a/content/en/docs/tasks/network/validate-dual-stack.md +++ b/content/en/docs/tasks/network/validate-dual-stack.md @@ -3,7 +3,7 @@ reviewers: - lachie83 - khenidak - bridgetkromhout -min-kubernetes-server-version: v1.20 +min-kubernetes-server-version: v1.23 title: Validate IPv4/IPv6 dual-stack content_type: task --- @@ -21,6 +21,9 @@ This document shares how to validate IPv4/IPv6 dual-stack enabled Kubernetes clu {{< version-check >}} +{{< note >}} +While you can validate with an earlier version, the feature is only GA and officially supported since v1.23. +{{< /note >}} From 466561c47c9421d0271db764ddf0bea461d4c877 Mon Sep 17 00:00:00 2001 From: ravisantoshgudimetla Date: Wed, 10 Nov 2021 12:56:10 -0500 Subject: [PATCH 27/68] [docs]: Promote STS minReadySeconds to beta --- .../workloads/controllers/statefulset.md | 22 ++++++++++--------- .../feature-gates.md | 3 ++- 2 files changed, 14 insertions(+), 11 deletions(-) diff --git a/content/en/docs/concepts/workloads/controllers/statefulset.md b/content/en/docs/concepts/workloads/controllers/statefulset.md index 6b65ba1f3b71c..4f12bb179608a 100644 --- a/content/en/docs/concepts/workloads/controllers/statefulset.md +++ b/content/en/docs/concepts/workloads/controllers/statefulset.md @@ -77,6 +77,7 @@ spec: app: nginx # has to match .spec.template.metadata.labels serviceName: "nginx" replicas: 3 # by default is 1 + minReadySeconds: 10 # by default is 0 template: metadata: labels: @@ -112,6 +113,17 @@ In the above example: The name of a StatefulSet object must be a valid [DNS subdomain name](/docs/concepts/overview/working-with-objects/names#dns-subdomain-names). + +### Minimum ready seconds + +{{< feature-state for_k8s_version="v1.23" state="beta" >}} + +`.spec.minReadySeconds` is an optional field that specifies the minimum number of seconds for which a newly +created Pod should be ready without any of its containers crashing, for it to be considered available. +Please note that this feature is beta and enabled by default. Please opt out by unsetting the StatefulSetMinReadySeconds flag, if you don't +want this feature to be enabled. This field defaults to 0 (the Pod will be considered +available as soon as it is ready). To learn more about when a Pod is considered ready, see [Container Probes](/docs/concepts/workloads/pods/pod-lifecycle/#container-probes). + ## Pod Selector You must set the `.spec.selector` field of a StatefulSet to match the labels of its `.spec.template.metadata.labels`. Prior to Kubernetes 1.8, the `.spec.selector` field was defaulted when omitted. In 1.8 and later versions, failing to specify a matching Pod Selector will result in a validation error during StatefulSet creation. @@ -284,16 +296,6 @@ After reverting the template, you must also delete any Pods that StatefulSet had already attempted to run with the bad configuration. StatefulSet will then begin to recreate the Pods using the reverted template. -### Minimum ready seconds - -{{< feature-state for_k8s_version="v1.22" state="alpha" >}} - -`.spec.minReadySeconds` is an optional field that specifies the minimum number of seconds for which a newly -created Pod should be ready without any of its containers crashing, for it to be considered available. -This defaults to 0 (the Pod will be considered available as soon as it is ready). To learn more about when -a Pod is considered ready, see [Container Probes](/docs/concepts/workloads/pods/pod-lifecycle/#container-probes). - -Please note that this field only works if you enable the `StatefulSetMinReadySeconds` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/). ## {{% heading "whatsnext" %}} diff --git a/content/en/docs/reference/command-line-tools-reference/feature-gates.md b/content/en/docs/reference/command-line-tools-reference/feature-gates.md index 8b2d4dd18e062..1ab8c95fdb8ce 100644 --- a/content/en/docs/reference/command-line-tools-reference/feature-gates.md +++ b/content/en/docs/reference/command-line-tools-reference/feature-gates.md @@ -182,7 +182,8 @@ different Kubernetes components. | `ServiceLoadBalancerClass` | `true` | Beta | 1.22 | | | `SizeMemoryBackedVolumes` | `false` | Alpha | 1.20 | 1.21 | | `SizeMemoryBackedVolumes` | `true` | Beta | 1.22 | | -| `StatefulSetMinReadySeconds` | `false` | Alpha | 1.22 | | +| `StatefulSetMinReadySeconds` | `false` | Alpha | 1.22 | 1.22 | +| `StatefulSetMinReadySeconds` | `true` | Beta | 1.23 | | | `StorageVersionAPI` | `false` | Alpha | 1.20 | | | `StorageVersionHash` | `false` | Alpha | 1.14 | 1.14 | | `StorageVersionHash` | `true` | Beta | 1.15 | | From 40d431a42c78ff96206aba2eebbdecbe018fa85e Mon Sep 17 00:00:00 2001 From: Michelle Au Date: Mon, 15 Nov 2021 13:51:53 -0800 Subject: [PATCH 28/68] update on-by-default for csi migration providers --- .../command-line-tools-reference/feature-gates.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/content/en/docs/reference/command-line-tools-reference/feature-gates.md b/content/en/docs/reference/command-line-tools-reference/feature-gates.md index 63eba752de109..96abe1230dc7a 100644 --- a/content/en/docs/reference/command-line-tools-reference/feature-gates.md +++ b/content/en/docs/reference/command-line-tools-reference/feature-gates.md @@ -71,13 +71,16 @@ different Kubernetes components. | `CSIMigration` | `false` | Alpha | 1.14 | 1.16 | | `CSIMigration` | `true` | Beta | 1.17 | | | `CSIMigrationAWS` | `false` | Alpha | 1.14 | | -| `CSIMigrationAWS` | `false` | Beta | 1.17 | | +| `CSIMigrationAWS` | `false` | Beta | 1.17 | 1.22 | +| `CSIMigrationAWS` | `true` | Beta | 1.23 | | | `CSIMigrationAzureDisk` | `false` | Alpha | 1.15 | 1.18 | -| `CSIMigrationAzureDisk` | `false` | Beta | 1.19 | | +| `CSIMigrationAzureDisk` | `false` | Beta | 1.19 | 1.22 | +| `CSIMigrationAzureDisk` | `true` | Beta | 1.23 | | | `CSIMigrationAzureFile` | `false` | Alpha | 1.15 | 1.19 | | `CSIMigrationAzureFile` | `false` | Beta | 1.21 | | | `CSIMigrationGCE` | `false` | Alpha | 1.14 | 1.16 | -| `CSIMigrationGCE` | `false` | Beta | 1.17 | | +| `CSIMigrationGCE` | `false` | Beta | 1.17 | 1.22 | +| `CSIMigrationGCE` | `true` | Beta | 1.23 | | | `CSIMigrationOpenStack` | `false` | Alpha | 1.14 | 1.17 | | `CSIMigrationOpenStack` | `true` | Beta | 1.18 | | | `CSIMigrationvSphere` | `false` | Beta | 1.19 | | From ee39fdc2ad7ee34b8893ec6b08dfd2d235d518b5 Mon Sep 17 00:00:00 2001 From: Joseph Burnett Date: Thu, 18 Nov 2021 11:22:40 +0100 Subject: [PATCH 29/68] Update docs with HPA v2 stable. --- .../horizontal-pod-autoscale-walkthrough.md | 10 ++--- .../horizontal-pod-autoscale.md | 41 ++++++++++--------- 2 files changed, 27 insertions(+), 24 deletions(-) diff --git a/content/en/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough.md b/content/en/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough.md index 545e268a101a2..f5582b9416a0d 100644 --- a/content/en/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough.md +++ b/content/en/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough.md @@ -184,9 +184,9 @@ Autoscaling the replicas may take a few minutes. ## Autoscaling on multiple metrics and custom metrics You can introduce additional metrics to use when autoscaling the `php-apache` Deployment -by making use of the `autoscaling/v2beta2` API version. +by making use of the `autoscaling/v2` API version. -First, get the YAML of your HorizontalPodAutoscaler in the `autoscaling/v2beta2` form: +First, get the YAML of your HorizontalPodAutoscaler in the `autoscaling/v2` form: ```shell kubectl get hpa php-apache -o yaml > /tmp/hpa-v2.yaml @@ -195,7 +195,7 @@ kubectl get hpa php-apache -o yaml > /tmp/hpa-v2.yaml Open the `/tmp/hpa-v2.yaml` file in an editor, and you should see YAML which looks like this: ```yaml -apiVersion: autoscaling/v2beta2 +apiVersion: autoscaling/v2 kind: HorizontalPodAutoscaler metadata: name: php-apache @@ -287,7 +287,7 @@ For example, if you had your monitoring system collecting metrics about network you could update the definition above using `kubectl edit` to look like this: ```yaml -apiVersion: autoscaling/v2beta2 +apiVersion: autoscaling/v2 kind: HorizontalPodAutoscaler metadata: name: php-apache @@ -411,7 +411,7 @@ access to any metric, so cluster administrators should take care when exposing i ## Appendix: Horizontal Pod Autoscaler Status Conditions -When using the `autoscaling/v2beta2` form of the HorizontalPodAutoscaler, you will be able to see +When using the `autoscaling/v2` form of the HorizontalPodAutoscaler, you will be able to see *status conditions* set by Kubernetes on the HorizontalPodAutoscaler. These status conditions indicate whether or not the HorizontalPodAutoscaler is able to scale, and whether or not it is currently restricted in any way. 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 27165d0ca7f2f..3208035a975db 100644 --- a/content/en/docs/tasks/run-application/horizontal-pod-autoscale.md +++ b/content/en/docs/tasks/run-application/horizontal-pod-autoscale.md @@ -62,7 +62,7 @@ or the custom metrics API (for all other metrics). * For object metrics and external metrics, a single metric is fetched, which describes the object in question. This metric is compared to the target - value, to produce a ratio as above. In the `autoscaling/v2beta2` API + value, to produce a ratio as above. In the `autoscaling/v2` API version, this value can optionally be divided by the number of Pods before the comparison is made. @@ -161,18 +161,17 @@ fluctuating metric values. ## API Object -The Horizontal Pod Autoscaler is an API resource in the Kubernetes `autoscaling` API group. -The current stable version, which only includes support for CPU autoscaling, -can be found in the `autoscaling/v1` API version. - -The beta version, which includes support for scaling on memory and custom metrics, -can be found in `autoscaling/v2beta2`. The new fields introduced in `autoscaling/v2beta2` -are preserved as annotations when working with `autoscaling/v1`. +The Horizontal Pod Autoscaler is an API resource in the Kubernetes +`autoscaling` API group. The current stable version can be found in +the `autoscaling/v2` API version which includes support for scaling on +memory and custom metrics. The new fields introduced in +`autoscaling/v2` are preserved as annotations when working with +`autoscaling/v1`. When you create a HorizontalPodAutoscaler API object, make sure the name specified is a valid [DNS subdomain name](/docs/concepts/overview/working-with-objects/names#dns-subdomain-names). More details about the API object can be found at -[HorizontalPodAutoscaler Object](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#horizontalpodautoscaler-v1-autoscaling). +[HorizontalPodAutoscaler Object](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#horizontalpodautoscaler-v2-autoscaling). ## Support for Horizontal Pod Autoscaler in kubectl @@ -299,7 +298,7 @@ the old container name from the HPA specification. ## Support for multiple metrics -Kubernetes 1.6 adds support for scaling based on multiple metrics. You can use the `autoscaling/v2beta2` API +Kubernetes 1.6 adds support for scaling based on multiple metrics. You can use the `autoscaling/v2` API version to specify multiple metrics for the Horizontal Pod Autoscaler to scale on. Then, the Horizontal Pod Autoscaler controller will evaluate each metric, and propose a new scale based on that metric. The largest of the proposed scales will be used as the new scale. @@ -313,9 +312,11 @@ custom metrics is still available, these metrics will not be available for use b annotations for specifying which custom metrics to scale on are no longer honored by the Horizontal Pod Autoscaler controller. {{< /note >}} -Kubernetes 1.6 adds support for making use of custom metrics in the Horizontal Pod Autoscaler. -You can add custom metrics for the Horizontal Pod Autoscaler to use in the `autoscaling/v2beta2` API. -Kubernetes then queries the new custom metrics API to fetch the values of the appropriate custom metrics. +You can also use a HorizontalPodAutoscaler to change the scale of a +workload based on custom metrics. You can add custom metrics for the +Horizontal Pod Autoscaler to use in the `autoscaling/v2` API. +Kubernetes then queries the new custom metrics API to fetch the values +of the appropriate custom metrics. See [Support for metrics APIs](#support-for-metrics-apis) for the requirements. @@ -349,12 +350,14 @@ and [the walkthrough for using external metrics](/docs/tasks/run-application/hor Starting from [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 -window can be specified for both directions which prevents the flapping of the -number of the replicas in the scaling target. Similarly specifying scaling -policies controls the rate of change of replicas while scaling. +the `v2beta2` API (and from v1.23 the `v2` 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 window +can be specified for both directions which prevents the flapping of +the number of the replicas in the scaling target. Similarly specifying +scaling policies controls the rate of change of replicas while +scaling. ### Scaling Policies From 7c1e61a697e268885a5cb8e248eb8fd48b59d6ac Mon Sep 17 00:00:00 2001 From: Peter Hunt Date: Mon, 22 Nov 2021 15:19:46 -0500 Subject: [PATCH 30/68] Document PodAndContainerStatsFromCRI feature Signed-off-by: Peter Hunt --- .../command-line-tools-reference/feature-gates.md | 3 +++ .../resource-metrics-pipeline.md | 9 +++++++++ 2 files changed, 12 insertions(+) diff --git a/content/en/docs/reference/command-line-tools-reference/feature-gates.md b/content/en/docs/reference/command-line-tools-reference/feature-gates.md index a4eb41f3f41a3..b433a951ab91b 100644 --- a/content/en/docs/reference/command-line-tools-reference/feature-gates.md +++ b/content/en/docs/reference/command-line-tools-reference/feature-gates.md @@ -362,6 +362,7 @@ different Kubernetes components. | `PersistentLocalVolumes` | `false` | Alpha | 1.7 | 1.9 | | `PersistentLocalVolumes` | `true` | Beta | 1.10 | 1.13 | | `PersistentLocalVolumes` | `true` | GA | 1.14 | - | +| `PodAndContainerStatsFromCRI` | `false` | Alpha | 1.23 | | | `PodDisruptionBudget` | `false` | Alpha | 1.3 | 1.4 | | `PodDisruptionBudget` | `true` | Beta | 1.5 | 1.20 | | `PodDisruptionBudget` | `true` | GA | 1.21 | - | @@ -862,6 +863,8 @@ Each feature gate is designed for enabling/disabling a specific feature: feature which allows users to influence ReplicaSet downscaling order. - `PersistentLocalVolumes`: Enable the usage of `local` volume type in Pods. Pod affinity has to be specified if requesting a `local` volume. +- `PodAndContainerStatsFromCRI`: Configure the kubelet to gather container and pod stats from the CRI container runtime + rather than gathering them from cAdvisor. - `PodDisruptionBudget`: Enable the [PodDisruptionBudget](/docs/tasks/run-application/configure-pdb/) feature. - `PodAffinityNamespaceSelector`: Enable the [Pod Affinity Namespace Selector](/docs/concepts/scheduling-eviction/assign-pod-node/#namespace-selector) and [CrossNamespacePodAffinity](/docs/concepts/policy/resource-quotas/#cross-namespace-pod-affinity-quota) quota scope features. diff --git a/content/en/docs/tasks/debug-application-cluster/resource-metrics-pipeline.md b/content/en/docs/tasks/debug-application-cluster/resource-metrics-pipeline.md index a8c24693dcda7..b0e9ec4690c3a 100644 --- a/content/en/docs/tasks/debug-application-cluster/resource-metrics-pipeline.md +++ b/content/en/docs/tasks/debug-application-cluster/resource-metrics-pipeline.md @@ -65,3 +65,12 @@ Metrics Server collects metrics from the Summary API, exposed by Learn more about the metrics server in [the design doc](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/instrumentation/metrics-server.md). + +### Summary API Source +The [Kubelet](/docs/reference/command-line-tools-reference/kubelet/) gathers stats at node, volume, pod and container level, and omits +them in the [Summary API](https://github.com/kubernetes/kubernetes/blob/7d309e0104fedb57280b261e5677d919cb2a0e2d/staging/src/k8s.io/kubelet/pkg/apis/stats/v1alpha1/types.go) +for consumers to read. + +Pre-1.23, these resources have been primarily gathered from [cAdvisor](https://github.com/google/cadvisor). However, in 1.23 with the +introduction of the `PodAndContainerStatsFromCRI` FeatureGate, container and pod level stats can be gathered by the CRI implementation. +Note: this also requires support from the CRI implementations (containerd >= 1.6.0, CRI-O >= 1.23.0). From 7d8483e0e4ebdddd5f03dcb455ee8047eacd6b85 Mon Sep 17 00:00:00 2001 From: Francesco Romani Date: Tue, 14 Sep 2021 18:01:51 +0200 Subject: [PATCH 31/68] node: cpumanager: document the graduation process Document the graduation process and the maturity level of the cpumanager policy options, and the new feature gate involved. No changes regarding the existing options. For more details: https://github.com/kubernetes/enhancements/pull/2933 Signed-off-by: Francesco Romani --- .../administer-cluster/cpu-management-policies.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/content/en/docs/tasks/administer-cluster/cpu-management-policies.md b/content/en/docs/tasks/administer-cluster/cpu-management-policies.md index 41fbe77cb039f..076cbe61497cc 100644 --- a/content/en/docs/tasks/administer-cluster/cpu-management-policies.md +++ b/content/en/docs/tasks/administer-cluster/cpu-management-policies.md @@ -60,6 +60,13 @@ duration as `--node-status-update-frequency`. The behavior of the static policy can be fine-tuned using the `--cpu-manager-policy-options` flag. The flag takes a comma-separated list of `key=value` policy options. +This feature can be disabled completely using the `CPUManagerPolicyOptions` feature gate. + +The policy options are split into two groups: alpha quality (hidden by default) and beta quality +(visible by default). The groups are guarded respectively by the `CPUManagerPolicyAlphaOptions` +and `CPUManagerPolicyBetaOptions` feature gates. Diverging from the Kubernetes standard, these +feature gates guard groups of options, because it would have been too cumbersome to add a feature +gate for each individual option. ### None policy @@ -218,6 +225,12 @@ equal to one. The `nginx` container is granted 2 exclusive CPUs. #### Static policy options +You can toggle groups of options on and off based upon their maturity level +using the following feature gates: +* `CPUManagerPolicyBetaOptions` default enabled. Disable to hide beta-level options. +* `CPUManagerPolicyAlphaOptions` default disabled. Enable to show alpha-level options. +You will still have to enable each option using the `CPUManagerPolicyOptions` kubelet option. + The following policy options exist for the static `CPUManager` policy: * `full-pcpus-only` (beta, visible by default) * `distribute-cpus-across-numa` (alpha, hidden by default) @@ -237,7 +250,7 @@ one NUMA node is required to satisfy the allocation. By default, the `CPUManager` will pack CPUs onto one NUMA node until it is filled, with any remaining CPUs simply spilling over to the next NUMA node. This can cause undesired bottlenecks in parallel code relying on barriers (and -similar synchronization primitivies), as this type of code tends to run only as +similar synchronization primitives), as this type of code tends to run only as fast as its slowest worker (which is slowed down by the fact that fewer CPUs are available on at least one NUMA node). By distributing CPUs evenly across NUMA nodes, application developers can more From d42a12c2eb2cd43137e1c694296991f68ec410cb Mon Sep 17 00:00:00 2001 From: Aldo Culquicondor Date: Mon, 22 Nov 2021 09:44:38 -0500 Subject: [PATCH 32/68] Add JobReadyPods feature gate --- .../reference/command-line-tools-reference/feature-gates.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/content/en/docs/reference/command-line-tools-reference/feature-gates.md b/content/en/docs/reference/command-line-tools-reference/feature-gates.md index a4eb41f3f41a3..d8513ad955ef2 100644 --- a/content/en/docs/reference/command-line-tools-reference/feature-gates.md +++ b/content/en/docs/reference/command-line-tools-reference/feature-gates.md @@ -129,6 +129,7 @@ different Kubernetes components. | `InTreePluginOpenStackUnregister` | `false` | Alpha | 1.21 | | | `InTreePluginvSphereUnregister` | `false` | Alpha | 1.21 | | | `JobMutableNodeSchedulingDirectives` | `true` | Beta | 1.23 | | +| `JobReadyPods` | `false` | Alpha | 1.23 | | | `JobTrackingWithFinalizers` | `false` | Alpha | 1.22 | 1.22 | | `JobTrackingWithFinalizers` | `true` | Beta | 1.23 | | | `KubeletCredentialProviders` | `false` | Alpha | 1.20 | | @@ -803,6 +804,11 @@ Each feature gate is designed for enabling/disabling a specific feature: support for IPv6. - `JobMutableNodeSchedulingDirectives`: Allows updating node scheduling directives in the pod template of [Job](/docs/concepts/workloads/controllers/job). +- `JobReadyPods`: Enables tracking the number of Pods that have a `Ready` + [condition](/docs/concepts/workloads/pods/pod-lifecycle/#pod-conditions). + The count of `Ready` pods is recorded in the + [status](/docs/reference/kubernetes-api/workload-resources/job-v1/#JobStatus) + of a [Job](/docs/concepts/workloads/controllers/job) status. - `JobTrackingWithFinalizers`: Enables tracking [Job](/docs/concepts/workloads/controllers/job) completions without relying on Pods remaining in the cluster indefinitely. The Job controller uses Pod finalizers and a field in the Job status to keep From 159234a0a6332e1007a8700e27eec9aaa861a622 Mon Sep 17 00:00:00 2001 From: Mengjiao Liu Date: Tue, 23 Nov 2021 15:51:22 +0800 Subject: [PATCH 33/68] kubelet: sysctls allows slashes as a separator --- .../docs/tasks/administer-cluster/sysctl-cluster.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/content/en/docs/tasks/administer-cluster/sysctl-cluster.md b/content/en/docs/tasks/administer-cluster/sysctl-cluster.md index f81623982ff5d..791df4a2b4e6b 100644 --- a/content/en/docs/tasks/administer-cluster/sysctl-cluster.md +++ b/content/en/docs/tasks/administer-cluster/sysctl-cluster.md @@ -13,6 +13,17 @@ This document describes how to configure and use kernel parameters within a Kubernetes cluster using the {{< glossary_tooltip term_id="sysctl" >}} interface. +{{< note >}} +Starting from Kubernetes version 1.23, the kubelet supports the use of either `/` or `.` +as separators for sysctl names. +For example, you can represent the same sysctl name as `kernel.shm_rmid_forced` using a +period as the separator, or as `kernel/shm_rmid_forced` using a slash as a separator. +For more sysctl parameter conversion method details, please refer to +the page [sysctl.d(5)](https://man7.org/linux/man-pages/man5/sysctl.d.5.html) from +the Linux man-pages project. +Setting Sysctls for a Pod and PodSecurityPolicy features do not yet support +setting sysctls with slashes. +{{< /note >}} ## {{% heading "prerequisites" %}} From 74dcb53cc5abf8a4680d9b4f7a6ce8e112cce0f1 Mon Sep 17 00:00:00 2001 From: kerthcet Date: Thu, 25 Nov 2021 11:26:25 +0800 Subject: [PATCH 34/68] add migration docs for scheduler component config api from v1beta2 to v1beta3 Signed-off-by: kerthcet --- .../en/docs/reference/scheduling/config.md | 33 ++----- .../en/docs/reference/scheduling/policies.md | 96 +------------------ 2 files changed, 10 insertions(+), 119 deletions(-) diff --git a/content/en/docs/reference/scheduling/config.md b/content/en/docs/reference/scheduling/config.md index bce8d36b5c7f0..dd883d3bac9fe 100644 --- a/content/en/docs/reference/scheduling/config.md +++ b/content/en/docs/reference/scheduling/config.md @@ -20,8 +20,7 @@ by implementing one or more of these extension points. You can specify scheduling profiles by running `kube-scheduler --config `, using the -KubeSchedulerConfiguration ([v1beta1](/docs/reference/config-api/kube-scheduler-config.v1beta1/) -or [v1beta2](/docs/reference/config-api/kube-scheduler-config.v1beta2/)) +KubeSchedulerConfiguration ([v1beta2](/docs/reference/config-api/kube-scheduler-config.v1beta2/)) struct. A minimal configuration looks as follows: @@ -179,30 +178,6 @@ that are not enabled by default: volume limits can be satisfied for the node. Extension points: `filter`. -The following plugins are deprecated and can only be enabled in a `v1beta1` -configuration: - -- `NodeResourcesLeastAllocated`: Favors nodes that have a low allocation of - resources. - Extension points: `score`. -- `NodeResourcesMostAllocated`: Favors nodes that have a high allocation of - resources. - Extension points: `score`. -- `RequestedToCapacityRatio`: Favor nodes according to a configured function of - the allocated resources. - Extension points: `score`. -- `NodeLabel`: Filters and / or scores a node according to configured - {{< glossary_tooltip text="label(s)" term_id="label" >}}. - Extension points: `filter`, `score`. -- `ServiceAffinity`: Checks that Pods that belong to a - {{< glossary_tooltip term_id="service" >}} fit in a set of nodes defined by - configured labels. This plugin also favors spreading the Pods belonging to a - Service across nodes. - Extension points: `preFilter`, `filter`, `score`. -- `NodePreferAvoidPods`: Prioritizes nodes according to the node annotation - `scheduler.alpha.kubernetes.io/preferAvoidPods`. - Extension points: `score`. - ### Multiple profiles You can configure `kube-scheduler` to run more than one profile. @@ -285,7 +260,13 @@ only has one pending pods queue. * A plugin enabled in a v1beta2 configuration file takes precedence over the default configuration for that plugin. * Invalid `host` or `port` configured for scheduler healthz and metrics bind address will cause validation failure. +{{% /tab %}} +{{% tab name="v1beta2 → v1beta3" %}} +* Three plugins' weight are increased by default: + * `InterPodAffinity` from 1 to 2 + * `NodeAffinity` from 1 to 2 + * `TaintToleration` from 1 to 3 {{% /tab %}} {{< /tabs >}} diff --git a/content/en/docs/reference/scheduling/policies.md b/content/en/docs/reference/scheduling/policies.md index 99291c2b373e7..d9a6d92cfe89a 100644 --- a/content/en/docs/reference/scheduling/policies.md +++ b/content/en/docs/reference/scheduling/policies.md @@ -6,99 +6,10 @@ weight: 10 -A scheduling Policy can be used to specify the *predicates* and *priorities* -that the {{< glossary_tooltip text="kube-scheduler" term_id="kube-scheduler" >}} -runs to [filter and score nodes](/docs/concepts/scheduling-eviction/kube-scheduler/#kube-scheduler-implementation), -respectively. +In Kubernetes versions before v1.23, a scheduling policy can be used to specify the *predicates* and *priorities* process. For example, you can set a scheduling policy by +running `kube-scheduler --policy-config-file ` or `kube-scheduler --policy-configmap `. -You can set a scheduling policy by running -`kube-scheduler --policy-config-file ` or -`kube-scheduler --policy-configmap ` -and using the [Policy type](/docs/reference/config-api/kube-scheduler-policy-config.v1/). - - - -## Predicates - -The following *predicates* implement filtering: - -- `PodFitsHostPorts`: Checks if a Node has free ports (the network protocol kind) - for the Pod ports the Pod is requesting. - -- `PodFitsHost`: Checks if a Pod specifies a specific Node by its hostname. - -- `PodFitsResources`: Checks if the Node has free resources (eg, CPU and Memory) - to meet the requirement of the Pod. - -- `MatchNodeSelector`: Checks if a Pod's Node {{< glossary_tooltip term_id="selector" >}} - matches the Node's {{< glossary_tooltip text="label(s)" term_id="label" >}}. - -- `NoVolumeZoneConflict`: Evaluate if the {{< glossary_tooltip text="Volumes" term_id="volume" >}} - that a Pod requests are available on the Node, given the failure zone restrictions for - that storage. - -- `NoDiskConflict`: Evaluates if a Pod can fit on a Node due to the volumes it requests, - and those that are already mounted. - -- `MaxCSIVolumeCount`: Decides how many {{< glossary_tooltip text="CSI" term_id="csi" >}} - volumes should be attached, and whether that's over a configured limit. - -- `PodToleratesNodeTaints`: checks if a Pod's {{< glossary_tooltip text="tolerations" term_id="toleration" >}} - can tolerate the Node's {{< glossary_tooltip text="taints" term_id="taint" >}}. - -- `CheckVolumeBinding`: Evaluates if a Pod can fit due to the volumes it requests. - This applies for both bound and unbound - {{< glossary_tooltip text="PVCs" term_id="persistent-volume-claim" >}}. - -## Priorities - -The following *priorities* implement scoring: - -- `SelectorSpreadPriority`: Spreads Pods across hosts, considering Pods that - belong to the same {{< glossary_tooltip text="Service" term_id="service" >}}, - {{< glossary_tooltip term_id="statefulset" >}} or - {{< glossary_tooltip term_id="replica-set" >}}. - -- `InterPodAffinityPriority`: Implements preferred - [inter pod affininity and antiaffinity](/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity). - -- `LeastRequestedPriority`: Favors nodes with fewer requested resources. In other - words, the more Pods that are placed on a Node, and the more resources those - Pods use, the lower the ranking this policy will give. - -- `MostRequestedPriority`: Favors nodes with most requested resources. This policy - will fit the scheduled Pods onto the smallest number of Nodes needed to run your - overall set of workloads. - -- `RequestedToCapacityRatioPriority`: Creates a requestedToCapacity based ResourceAllocationPriority using default resource scoring function shape. - -- `BalancedResourceAllocation`: Favors nodes with balanced resource usage. - -- `NodePreferAvoidPodsPriority`: Prioritizes nodes according to the node annotation - `scheduler.alpha.kubernetes.io/preferAvoidPods`. You can use this to hint that - two different Pods shouldn't run on the same Node. - -- `NodeAffinityPriority`: Prioritizes nodes according to node affinity scheduling - preferences indicated in PreferredDuringSchedulingIgnoredDuringExecution. - You can read more about this in [Assigning Pods to Nodes](/docs/concepts/scheduling-eviction/assign-pod-node/). - -- `TaintTolerationPriority`: Prepares the priority list for all the nodes, based on - the number of intolerable taints on the node. This policy adjusts a node's rank - taking that list into account. - -- `ImageLocalityPriority`: Favors nodes that already have the - {{< glossary_tooltip text="container images" term_id="image" >}} for that - Pod cached locally. - -- `ServiceSpreadingPriority`: For a given Service, this policy aims to make sure that - the Pods for the Service run on different nodes. It favours scheduling onto nodes - that don't have Pods for the service already assigned there. The overall outcome is - that the Service becomes more resilient to a single Node failure. - -- `EqualPriority`: Gives an equal weight of one to all nodes. - -- `EvenPodsSpreadPriority`: Implements preferred - [pod topology spread constraints](/docs/concepts/workloads/pods/pod-topology-spread-constraints/). +This scheduling policy is not supported since Kubernetes v1.23. Associated flags `policy-config-file`, `policy-configmap`, `policy-configmap-namespace` and `use-legacy-policy-config` are also not supported. Instead, use the [Scheduler Configuration](/docs/reference/scheduling/config/) to achieve similar behavior. ## {{% heading "whatsnext" %}} @@ -106,4 +17,3 @@ The following *priorities* implement scoring: * Learn about [kube-scheduler Configuration](/docs/reference/scheduling/config/) * Read the [kube-scheduler configuration reference (v1beta2)](/docs/reference/config-api/kube-scheduler-config.v1beta2) * Read the [kube-scheduler Policy reference (v1)](/docs/reference/config-api/kube-scheduler-policy-config.v1/) - From 280229b0ec15a362411694dc3ba1b96dd8380cf4 Mon Sep 17 00:00:00 2001 From: Humble Chirammal Date: Wed, 17 Nov 2021 23:35:44 +0530 Subject: [PATCH 35/68] Add RBD CSI migration section to the storage volumes guide Kubernetes adds the RBD CSI migration functionality via CSI migration translation lib. Ref# kubernetes/kubernetes#95361 This commit add the migration details to volumes.md and feature-gates.md Signed-off-by: Humble Chirammal --- content/en/docs/concepts/storage/volumes.md | 42 ++++++++++++++++--- .../feature-gates.md | 8 ++++ 2 files changed, 45 insertions(+), 5 deletions(-) diff --git a/content/en/docs/concepts/storage/volumes.md b/content/en/docs/concepts/storage/volumes.md index 56694dee66c32..f0d005722f636 100644 --- a/content/en/docs/concepts/storage/volumes.md +++ b/content/en/docs/concepts/storage/volumes.md @@ -956,11 +956,11 @@ GitHub project has [instructions](https://github.com/quobyte/quobyte-csi#quobyte ### rbd An `rbd` volume allows a -[Rados Block Device](https://docs.ceph.com/en/latest/rbd/) (RBD) volume to mount into your -Pod. Unlike `emptyDir`, which is erased when a pod is removed, the contents of -an `rbd` volume are preserved and the volume is unmounted. This -means that a RBD volume can be pre-populated with data, and that data can -be shared between pods. +[Rados Block Device](https://docs.ceph.com/en/latest/rbd/) (RBD) volume to mount +into your Pod. Unlike `emptyDir`, which is erased when a pod is removed, the +contents of an `rbd` volume are preserved and the volume is unmounted. This +means that a RBD volume can be pre-populated with data, and that data can be +shared between pods. {{< note >}} You must have a Ceph installation running before you can use RBD. @@ -975,6 +975,38 @@ Simultaneous writers are not allowed. See the [RBD example](https://github.com/kubernetes/examples/tree/master/volumes/rbd) for more details. +#### RBD CSI migration {#rbd-csi-migration} + +{{< feature-state for_k8s_version="v1.23" state="alpha" >}} + +The `CSIMigration` feature for `RBD`, when enabled, redirects all plugin +operations from the existing in-tree plugin to the `rbd.csi.ceph.com` {{< +glossary_tooltip text="CSI" term_id="csi" >}} driver. In order to use this +feature, the +[Ceph CSI driver](https://github.com/ceph/ceph-csi) +must be installed on the cluster and the `CSIMigration` and `CSIMigrationRBD` +[feature gates](/docs/reference/command-line-tools-reference/feature-gates/) +must be enabled. + +{{< note >}} + +As a Kubernetes cluster operator that administers storage, here are the +prerequisites that you must complete before you attempt migration to the +RBD CSI driver: + +* You must install the Ceph CSI driver (`rbd.csi.ceph.com`), v3.5.0 or above, + into your Kubernetes cluster. +* considering the `clusterID` field is a required parameter for CSI driver for + its operations, but in-tree StorageClass has `monitors` field as a required + parameter, a Kubernetes storage admin has to create a clusterID based on the + monitors hash ( ex:`#echo -n + '' | md5sum`) in the CSI config map and keep the monitors + under this clusterID configuration. +* Also, if the value of `adminId` in the in-tree Storageclass is different from + `admin`, the `adminSecretName` mentioned in the in-tree Storageclass has to be + patched with the base64 value of the `adminId` parameter value, otherwise this + step can be skipped. {{< /note >}} + ### secret A `secret` volume is used to pass sensitive information, such as passwords, to diff --git a/content/en/docs/reference/command-line-tools-reference/feature-gates.md b/content/en/docs/reference/command-line-tools-reference/feature-gates.md index 63eba752de109..e9befb359c924 100644 --- a/content/en/docs/reference/command-line-tools-reference/feature-gates.md +++ b/content/en/docs/reference/command-line-tools-reference/feature-gates.md @@ -81,6 +81,7 @@ different Kubernetes components. | `CSIMigrationOpenStack` | `false` | Alpha | 1.14 | 1.17 | | `CSIMigrationOpenStack` | `true` | Beta | 1.18 | | | `CSIMigrationvSphere` | `false` | Beta | 1.19 | | +| `CSIMigrationRBD` | `false` | Alpha | 1.23 | | | `CSIStorageCapacity` | `false` | Alpha | 1.19 | 1.20 | | `CSIStorageCapacity` | `true` | Beta | 1.21 | | | `CSIVolumeHealth` | `false` | Alpha | 1.21 | | @@ -622,6 +623,13 @@ Each feature gate is designed for enabling/disabling a specific feature: operations from the GCE-PD in-tree plugin to PD CSI plugin. Supports falling back to in-tree GCE plugin if a node does not have PD CSI plugin installed and configured. Requires CSIMigration feature flag enabled. +- `CSIMigrationRBD`: Enables shims and translation logic to route volume + operations from the RBD in-tree plugin to Ceph RBD CSI plugin. Requires + CSIMigration and CSIMigrationRBD feature flags enabled and Ceph CSI plugin + installed and configured in the cluster. This flag has been deprecated in + favor of the + `InTreePluginRBDUnregister` feature flag which prevents the registration of + in-tree RBD plugin. - `CSIMigrationGCEComplete`: Stops registering the GCE-PD in-tree plugin in kubelet and volume controllers and enables shims and translation logic to route volume operations from the GCE-PD in-tree plugin to PD CSI plugin. From b8a9baeb89fde4b9670cf8c3c664afc9f5cf6fbd Mon Sep 17 00:00:00 2001 From: Tim Bannister Date: Sun, 28 Nov 2021 19:05:16 +0000 Subject: [PATCH 36/68] De-emphasize scheduling priorities Scheduling priorities are deprecated, so: - move the page later in the parent topic - hint that it's not a priority in the sitemap for the live docs --- content/en/docs/reference/scheduling/policies.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/content/en/docs/reference/scheduling/policies.md b/content/en/docs/reference/scheduling/policies.md index d9a6d92cfe89a..3e2e554fc9686 100644 --- a/content/en/docs/reference/scheduling/policies.md +++ b/content/en/docs/reference/scheduling/policies.md @@ -1,7 +1,8 @@ --- title: Scheduling Policies content_type: concept -weight: 10 +sitemap: + priority: 0.2 # Scheduling priorities are deprecated --- From 9ea79fa719f12510178898af5835ad46485ae3fe Mon Sep 17 00:00:00 2001 From: ravisantoshgudimetla Date: Mon, 29 Nov 2021 09:06:51 -0500 Subject: [PATCH 37/68] [docs]: Update existing fields in STS spec --- .../concepts/workloads/controllers/statefulset.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/content/en/docs/concepts/workloads/controllers/statefulset.md b/content/en/docs/concepts/workloads/controllers/statefulset.md index 4f12bb179608a..5197fe4f20d25 100644 --- a/content/en/docs/concepts/workloads/controllers/statefulset.md +++ b/content/en/docs/concepts/workloads/controllers/statefulset.md @@ -113,6 +113,14 @@ In the above example: The name of a StatefulSet object must be a valid [DNS subdomain name](/docs/concepts/overview/working-with-objects/names#dns-subdomain-names). +### Pod Selector + +You must set the `.spec.selector` field of a StatefulSet to match the labels of its `.spec.template.metadata.labels`. In 1.8 and later versions, failing to specify a matching Pod Selector will result in a validation error during StatefulSet creation. + +### Volume Claim Templates + +You can set the `.spec.volumeClaimTemplates` which can provide stable storage using [PersistentVolumes](/docs/concepts/storage/persistent-volumes/) provisioned by a PersistentVolume Provisioner. + ### Minimum ready seconds @@ -124,10 +132,6 @@ Please note that this feature is beta and enabled by default. Please opt out by want this feature to be enabled. This field defaults to 0 (the Pod will be considered available as soon as it is ready). To learn more about when a Pod is considered ready, see [Container Probes](/docs/concepts/workloads/pods/pod-lifecycle/#container-probes). -## Pod Selector - -You must set the `.spec.selector` field of a StatefulSet to match the labels of its `.spec.template.metadata.labels`. Prior to Kubernetes 1.8, the `.spec.selector` field was defaulted when omitted. In 1.8 and later versions, failing to specify a matching Pod Selector will result in a validation error during StatefulSet creation. - ## Pod Identity StatefulSet Pods have a unique identity that is comprised of an ordinal, a From e6a9fd269e762c4b1ca638b207cfb7704ad37d60 Mon Sep 17 00:00:00 2001 From: Jordan Liggitt Date: Mon, 29 Nov 2021 09:46:22 -0500 Subject: [PATCH 38/68] Update webhook anchor --- content/en/docs/concepts/security/pod-security-admission.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/concepts/security/pod-security-admission.md b/content/en/docs/concepts/security/pod-security-admission.md index 933dc62940876..5969d2bb5d7ed 100644 --- a/content/en/docs/concepts/security/pod-security-admission.md +++ b/content/en/docs/concepts/security/pod-security-admission.md @@ -44,7 +44,7 @@ is an Alpha feature and must be enabled in `kube-apiserver` in order to use the --feature-gates="...,PodSecurity=true" ``` -## Alternative: installing the `PodSecurity` admission webhook +## Alternative: installing the `PodSecurity` admission webhook {#webhook} For environments where the built-in `PodSecurity` admission plugin cannot be used, either because the cluster is older than v1.22, or the `PodSecurity` feature cannot be enabled, From a9641b6ccd33f8899eb628326324d97f3dfd2951 Mon Sep 17 00:00:00 2001 From: Joe Betz Date: Mon, 15 Nov 2021 15:44:54 -0500 Subject: [PATCH 39/68] Add stub for validatiton rule documentation --- .../custom-resource-definitions.md | 83 ++++++++++++++++++- 1 file changed, 81 insertions(+), 2 deletions(-) diff --git a/content/en/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions.md b/content/en/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions.md index cd2d0fb1038e6..538bc608211ad 100644 --- a/content/en/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions.md +++ b/content/en/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions.md @@ -556,8 +556,9 @@ deleted by Kubernetes. ### Validation Custom resources are validated via -[OpenAPI v3 schemas](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#schemaObject) -and you can add additional validation using +[OpenAPI v3 schemas](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#schemaObject), +by x-kubernetes-validation-rules when the [Validation Rules feature](#validation-rules) is enabled, and you +can add additional validation using [admission webhooks](/docs/reference/access-authn-authz/admission-controllers/#validatingadmissionwebhook). Additionally, the following restrictions are applied to the schema: @@ -577,6 +578,11 @@ Additionally, the following restrictions are applied to the schema: - The field `additionalProperties` cannot be set to `false`. - The field `additionalProperties` is mutually exclusive with `properties`. +The `x-kubernetes-validation-rules` extension can be use to validate custom resources using [Common +Expression Language (CEL)](https://github.com/google/cel-spec) expressions when the [Validation +Rules feature](#validation-rules) feature is enabled and the CustomResourceDefinition schema is a +[structural schema](#specifying-a-structural-schema). + The `default` field can be set when the [Defaulting feature](#defaulting) is enabled, which is the case with `apiextensions.k8s.io/v1` CustomResourceDefinitions. Defaulting is in GA since 1.17 (beta since 1.16 with the `CustomResourceDefaulting` @@ -693,6 +699,79 @@ kubectl apply -f my-crontab.yaml crontab "my-new-cron-object" created ``` +## Validation rules + +{{< feature-state state="alpha" for_k8s_version="v1.23" >}} + +Validation rules are in alpha since 1.23 and validate custom resources when the +`CustomResourceValidationExpressions` [feature +gate](/docs/reference/command-line-tools-reference/feature-gates/) enabled and the schema is a +[structural schema](#specifying-a-structural-schema). + +Validation rules use the [Common Expression Language (CEL)](https://github.com/google/cel-spec) +expression language to validate custom resource values. Validation rules are included in +CustomResourceDefinition schemas using the `x-kubernetes-validation-rules` extension. + +For example: + +```yaml + ... + openAPIV3Schema: + type: object + properties: + spec: + type: object + x-kubernetes-validation-rules: + - rule: "self.minReplicas <= self.replicas" + - rule: "self.replicas <= self.maxReplicas" + properties: + ... + minReplicas: + type: integer + replicas: + type: integer + maxReplicas: + type: integer +``` + +will reject an request to create this custom resource: + +```yaml +apiVersion: "stable.example.com/v1" +kind: CronTab +metadata: + name: my-new-cron-object +spec: + minReplicas: 0 + replicas: 20 + maxReplicas: 10 +``` + +with the response: + +``` +The CronTab "my-new-cron-object" is invalid: +* spec: Invalid value: map[string]interface {}{"minReplicas": 0, "replicas":20, "maxReplicas": 10}: failed rule: self.minReplicas <= self.replicas && self.replicas <= self.maxReplicas +``` + +TODO: (using text from types_jsonprops.go and KEP were applicable, but using "full" multi-line examples that include both the schema and the custom resource data) +- Explain that rules are compiled when CRDs are created/updated. Show full example including compilation error output examples. +- Explain scope, self, and how objects, maps and arrays are accessed. Show full examples. + - Must show: 'self.field' selection, has() field presence checking, 'self[key]' map access and + 'key in self' map containment, 'self[i]' list access, all/exists/filter and how they apply to + maps and lists. Show more of the functions than covered in types_jsonprops.go. Provide links to + functions and macros in spec. Provide link to strings extension library in cel-go that we have + enabled. Explain that this is an extension library. +- Include examples table from KEP? Probably just past it in and add context. +- Explain access to type and object meta. +- Explain openapiv3 -> CEL declarations type mapping and include the table from the KEP. Link to OpenAPIv3 and CEL documentation about types. +- Explain int-or-string, preserve-unknown, nullable, embedded. Provide some short examples. +- Explain escaping using a table. Provide some short examples. Provide guidance on how to name + properties (both in this section of this document and elsewhere in this document where property + names are introduced/discussed). +- Explain + and == for list maps and list sets (table? whatever looks better) +- DO NOT: provide all the motivation and design rationale from the KEP. + ### Defaulting {{< note >}} From 9d69f673999a171a5660b0177792808c4e3ee6f1 Mon Sep 17 00:00:00 2001 From: cici37 Date: Thu, 18 Nov 2021 13:27:39 -0800 Subject: [PATCH 40/68] Add feature gate `CustomResourceValidationExpressions` into /command-line-tools-reference/feature-gates.md --- .../reference/command-line-tools-reference/feature-gates.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/content/en/docs/reference/command-line-tools-reference/feature-gates.md b/content/en/docs/reference/command-line-tools-reference/feature-gates.md index d369723ec889f..000fac1e82418 100644 --- a/content/en/docs/reference/command-line-tools-reference/feature-gates.md +++ b/content/en/docs/reference/command-line-tools-reference/feature-gates.md @@ -93,6 +93,7 @@ different Kubernetes components. | `ControllerManagerLeaderMigration` | `false` | Alpha | 1.21 | 1.21 | | `ControllerManagerLeaderMigration` | `true` | Beta | 1.22 | | | `CustomCPUCFSQuotaPeriod` | `false` | Alpha | 1.12 | | +| `CustomResourceValidationExpressions` | `false` | Alpha | 1.23 | | | `DaemonSetUpdateSurge` | `false` | Alpha | 1.21 | 1.21 | | `DaemonSetUpdateSurge` | `true` | Beta | 1.22 | | | `DefaultPodTopologySpread` | `false` | Alpha | 1.19 | 1.19 | @@ -684,6 +685,7 @@ Each feature gate is designed for enabling/disabling a specific feature: version 1 of the same controller is selected. - `CustomCPUCFSQuotaPeriod`: Enable nodes to change `cpuCFSQuotaPeriod` in [kubelet config](/docs/tasks/administer-cluster/kubelet-config-file/). +- `CustomResourceValidationExpressions`: Enable expression language validation in CRD which will validate customer resource based on validation rules written in `x-kubernetes-validations` extension. - `CustomPodDNS`: Enable customizing the DNS settings for a Pod using its `dnsConfig` property. Check [Pod's DNS Config](/docs/concepts/services-networking/dns-pod-service/#pods-dns-config) for more details. From cd1726aa1091d53c7fe7f6f59c0469761b0986a1 Mon Sep 17 00:00:00 2001 From: cici37 Date: Wed, 17 Nov 2021 19:49:08 -0800 Subject: [PATCH 41/68] Adding details on CEL validation for CRD. --- .../custom-resource-definitions.md | 284 ++++++++++++++++-- 1 file changed, 254 insertions(+), 30 deletions(-) diff --git a/content/en/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions.md b/content/en/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions.md index 538bc608211ad..e4c5e3991555a 100644 --- a/content/en/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions.md +++ b/content/en/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions.md @@ -557,7 +557,7 @@ deleted by Kubernetes. Custom resources are validated via [OpenAPI v3 schemas](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#schemaObject), -by x-kubernetes-validation-rules when the [Validation Rules feature](#validation-rules) is enabled, and you +by x-kubernetes-validations when the [Validation Rules feature](#validation-rules) is enabled, and you can add additional validation using [admission webhooks](/docs/reference/access-authn-authz/admission-controllers/#validatingadmissionwebhook). @@ -578,9 +578,9 @@ Additionally, the following restrictions are applied to the schema: - The field `additionalProperties` cannot be set to `false`. - The field `additionalProperties` is mutually exclusive with `properties`. -The `x-kubernetes-validation-rules` extension can be use to validate custom resources using [Common +The `x-kubernetes-validations` extension can be used to validate custom resources using [Common Expression Language (CEL)](https://github.com/google/cel-spec) expressions when the [Validation -Rules feature](#validation-rules) feature is enabled and the CustomResourceDefinition schema is a +rules](#validation-rules) feature is enabled and the CustomResourceDefinition schema is a [structural schema](#specifying-a-structural-schema). The `default` field can be set when the [Defaulting feature](#defaulting) is enabled, @@ -705,12 +705,16 @@ crontab "my-new-cron-object" created Validation rules are in alpha since 1.23 and validate custom resources when the `CustomResourceValidationExpressions` [feature -gate](/docs/reference/command-line-tools-reference/feature-gates/) enabled and the schema is a +gate](/docs/reference/command-line-tools-reference/feature-gates/) is enabled. +This feature is only available if the schema is a [structural schema](#specifying-a-structural-schema). Validation rules use the [Common Expression Language (CEL)](https://github.com/google/cel-spec) -expression language to validate custom resource values. Validation rules are included in -CustomResourceDefinition schemas using the `x-kubernetes-validation-rules` extension. +to validate custom resource values. Validation rules are included in +CustomResourceDefinition schemas using the `x-kubernetes-validations` extension. + +The Rule is scoped to the location of the `x-kubernetes-validations` extension in the schema. +And `self` variable in the CEL expression is bound to the scoped value. For example: @@ -721,9 +725,11 @@ For example: properties: spec: type: object - x-kubernetes-validation-rules: - - rule: "self.minReplicas <= self.replicas" - - rule: "self.replicas <= self.maxReplicas" + x-kubernetes-validation-rules: + - rule: "self.minReplicas <= self.replicas" + message: "replicas should be greater than or equal to minReplicas." + - rule: "self.replicas <= self.maxReplicas" + message: "replicas should be smaller than or equal to maxReplicas." properties: ... minReplicas: @@ -732,9 +738,13 @@ For example: type: integer maxReplicas: type: integer + required: + - minReplicas + - replicas + - maxReplicas ``` -will reject an request to create this custom resource: +will reject a request to create this custom resource: ```yaml apiVersion: "stable.example.com/v1" @@ -751,26 +761,240 @@ with the response: ``` The CronTab "my-new-cron-object" is invalid: -* spec: Invalid value: map[string]interface {}{"minReplicas": 0, "replicas":20, "maxReplicas": 10}: failed rule: self.minReplicas <= self.replicas && self.replicas <= self.maxReplicas -``` - -TODO: (using text from types_jsonprops.go and KEP were applicable, but using "full" multi-line examples that include both the schema and the custom resource data) -- Explain that rules are compiled when CRDs are created/updated. Show full example including compilation error output examples. -- Explain scope, self, and how objects, maps and arrays are accessed. Show full examples. - - Must show: 'self.field' selection, has() field presence checking, 'self[key]' map access and - 'key in self' map containment, 'self[i]' list access, all/exists/filter and how they apply to - maps and lists. Show more of the functions than covered in types_jsonprops.go. Provide links to - functions and macros in spec. Provide link to strings extension library in cel-go that we have - enabled. Explain that this is an extension library. -- Include examples table from KEP? Probably just past it in and add context. -- Explain access to type and object meta. -- Explain openapiv3 -> CEL declarations type mapping and include the table from the KEP. Link to OpenAPIv3 and CEL documentation about types. -- Explain int-or-string, preserve-unknown, nullable, embedded. Provide some short examples. -- Explain escaping using a table. Provide some short examples. Provide guidance on how to name - properties (both in this section of this document and elsewhere in this document where property - names are introduced/discussed). -- Explain + and == for list maps and list sets (table? whatever looks better) -- DO NOT: provide all the motivation and design rationale from the KEP. +* spec: Invalid value: map[string]interface {}{"maxReplicas":10, "minReplicas":0, "replicas":20}: replicas should be smaller than or equal to maxReplicas. +``` + +`x-kubernetes-validations` could have multiple rules. + +The `rule` under `x-kubernetes-validations` represents the expression which will be evaluated by CEL. + +The `message` represents the message displayed when validation fails. If message is unset, the above response would be: +``` +The CronTab "my-new-cron-object" is invalid: +* spec: Invalid value: map[string]interface {}{"maxReplicas":10, "minReplicas":0, "replicas":20}: failed rule: self.replicas <= self.maxReplicas +``` + +Validation rules are compiled when CRDs are created/updated. +The request of CRDs create/update will fail if compilation of validation rules fail. +Compilation process includes type checking as well. + +The compilation failure: +- `no_matching_overload`: this function has no overload for the types of the arguments. + + e.g. Rule like `self == true` against a field of integer type will get error: + ``` + Invalid value: apiextensions.ValidationRule{Rule:"self == true", Message:""}: compilation failed: ERROR: \:1:6: found no matching overload for '_==_' applied to '(int, bool)' + ``` + +- `no_such_field`: does not contain the desired field. + + e.g. Rule like `self.nonExistingField > 0` against a non-existing field will return the error: + ``` + Invalid value: apiextensions.ValidationRule{Rule:"self.nonExistingField > 0", Message:""}: compilation failed: ERROR: \:1:5: undefined field 'nonExistingField' + ``` + +- `invalid argument`: invalid argument to macros. + + e.g. Rule like `has(self)` will return error: + ``` + Invalid value: apiextensions.ValidationRule{Rule:"has(self)", Message:""}: compilation failed: ERROR: :1:4: invalid argument to has() macro + ``` + + +Validation Rules Examples: + +| Rule | Purpose | +| ---------------- | ------------ | +| `self.minReplicas <= self.replicas && self.replicas <= self.maxReplicas` | Validate that the three fields defining replicas are ordered appropriately | +| `'Available' in self.stateCounts` | Validate that an entry with the 'Available' key exists in a map | +| `(size(self.list1) == 0) != (size(self.list2) == 0)` | Validate that one of two lists is non-empty, but not both | +| !('MY_KEY' in self.map1) || self['MY_KEY'].matches('^[a-zA-Z]*$') | Validate the value of a map for a specific key, if it is in the map | +| `self.envars.filter(e, e.name = 'MY_ENV').all(e, e.value.matches('^[a-zA-Z]*$')` | Validate the 'value' field of a listMap entry where key field 'name' is 'MY_ENV' | +| `has(self.expired) && self.created + self.ttl < self.expired` | Validate that 'expired' date is after a 'create' date plus a 'ttl' duration | +| `self.health.startsWith('ok')` | Validate a 'health' string field has the prefix 'ok' | +| `self.widgets.exists(w, w.key == 'x' && w.foo < 10)` | Validate that the 'foo' property of a listMap item with a key 'x' is less than 10 | +| `type(self) == string ? self == '100%' : self == 1000` | Validate an int-or-string field for both the the int and string cases | +| `self.metadata.name.startsWith(self.prefix)` | Validate that an object's name has the prefix of another field value | +| `self.set1.all(e, !(e in self.set2))` | Validate that two listSets are disjoint | +| `size(self.names) == size(self.details) && self.names.all(n, n in self.details)` | Validate the 'details' map is keyed by the items in the 'names' listSet | + +Xref: [Supported evaluation on CEL](https://github.com/google/cel-spec/blob/v0.6.0/doc/langdef.md#evaluation) + + +- If the Rule is scoped to the root of a resource, it may make field selection into any fields + declared in the OpenAPIv3 schema of the CRD as well as `apiVersion`, `kind`, `metadata.name` and + `metadata.generateName`. This includes selection of fields in both the `spec` and `status` in the + same expression: + ```yaml + ... + openAPIV3Schema: + type: object + x-kubernetes-validation-rules: + - rule: "self.status.availableReplicas >= self.spec.minReplicas" + properties: + spec: + type: object + properties: + minReplicas: + type: integer + ... + status: + type: object + properties: + availableReplicas: + type: integer + ``` + +- If the Rule is scoped to an object with properties, the accessible properties of the object are field selectable + via `self.field` and field presence can be checked via `has(self.field)`. Null valued fields are treated as + absent fields in CEL expressions. + + ```yaml + ... + openAPIV3Schema: + type: object + properties: + spec: + type: object + x-kubernetes-validation-rules: + - rule: "has(self.foo)" + properties: + ... + foo: + type: integer + ``` + +- If the Rule is scoped to an object with additionalProperties (i.e. a map) the value of the map + are accessible via `self[mapKey]`, map containment can be checked via `mapKey in self` and all entries of the map + are accessible via CEL macros and functions such as `self.all(...)`. + ```yaml + ... + openAPIV3Schema: + type: object + properties: + spec: + type: object + x-kubernetes-validation-rules: + - rule: "self['xyz'].foo > 0" + additionalProperties: + ... + type: object + properties: + foo: + type: integer + ``` + +- If the Rule is scoped to an array, the elements of the array are accessible via `self[i]` and also by macros and + functions. + ```yaml + ... + openAPIV3Schema: + type: object + properties: + ... + foo: + type: array + x-kubernetes-validation-rules: + - rule: "size(self) == 1" + items: + type: string + ``` + +- If the Rule is scoped to a scalar, `self` is bound to the scalar value. + ```yaml + ... + openAPIV3Schema: + type: object + properties: + spec: + type: object + properties: + ... + foo: + type: integer + x-kubernetes-validation-rules: + - rule: "self > 0" + ``` +Examples: + +|type of the field rule scoped to | Rule example | +| -----------------------| -----------------------| +| root object | `self.status.actual <= self.spec.maxDesired`| +| map of objects | `self.components['Widget'].priority < 10`| +| list of integers | `self.values.all(value, value >= 0 && value < 100)`| +| string | `self.startsWith('kube')`| + + +The `apiVersion`, `kind`, `metadata.name` and `metadata.generateName` are always accessible from the root of the +object and from any x-kubernetes-embedded-resource annotated objects. No other metadata properties are accessible. + +Unknown data preserved in custom resources via `x-kubernetes-preserve-unknown-fields` is not accessible in CEL + expressions. This includes: + - Unknown field values that are preserved by object schemas with x-kubernetes-preserve-unknown-fields. + - Object properties where the property schema is of an "unknown type". An "unknown type" is recursively defined as: + - A schema with no type and x-kubernetes-preserve-unknown-fields set to true + - An array where the items schema is of an "unknown type" + - An object where the additionalProperties schema is of an "unknown type" + + +Only property names of the form `[a-zA-Z_.-/][a-zA-Z0-9_.-/]*` are accessible. +Accessible property names are escaped according to the following rules when accessed in the expression: + +| escape sequence | property name equivalent | +| ----------------------- | -----------------------| +| `__underscores__` | `__` | +| `__dot__` | `.` | +|`__dash__` | `-` | +| `__slash__` | `/` | +| `__{keyword}__` | [CEL RESERVED keyword](https://github.com/google/cel-spec/blob/v0.6.0/doc/langdef.md#syntax) | + +Note: CEL RESERVED keyword needs to match the exact property name to be escaped (e.g. int in the word sprint would not be escaped). + +Examples on escaping: + +|property name | rule with escaped property name | +| ----------------| ----------------------- | +| namespace | `self.__namespace__ > 0` | +| x-prop | `self.x__dash__prop > 0` | +| redact__d | `self.redact__underscores__d > 0` | +| string | `self.startsWith('kube')` | + + +Equality on arrays with `x-kubernetes-list-type` of `set` or `map` ignores element order, i.e. [1, 2] == [2, 1]. +Concatenation on arrays with x-kubernetes-list-type use the semantics of the list type: + - `set`: `X + Y` performs a union where the array positions of all elements in `X` are preserved and + non-intersecting elements in `Y` are appended, retaining their partial order. + - `map`: `X + Y` performs a merge where the array positions of all keys in `X` are preserved but the values + are overwritten by values in `Y` when the key sets of `X` and `Y` intersect. Elements in `Y` with + non-intersecting keys are appended, retaining their partial order. + + +Here is the declarations type mapping between OpenAPIv3 and CEL type: + +| OpenAPIv3 type | CEL type | +| -------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| 'object' with Properties | object / "message type" | +| 'object' with AdditionalProperties | map | +| 'object' with x-kubernetes-embedded-type | object / "message type", 'apiVersion', 'kind', 'metadata.name' and 'metadata.generateName' are implicitly included in schema | +| 'object' with x-kubernetes-preserve-unknown-fields | object / "message type", unknown fields are NOT accessible in CEL expression | +| x-kubernetes-int-or-string | dynamic object that is either an int or a string, `type(value)` can be used to check the type | +| 'array | list | +| 'array' with x-kubernetes-list-type=map | list with map based Equality & unique key guarantees | +| 'array' with x-kubernetes-list-type=set | list with set based Equality & unique entry guarantees | +| 'boolean' | boolean | +| 'number' (all formats) | double | +| 'integer' (all formats) | int (64) | +| 'null' | null_type | +| 'string' | string | +| 'string' with format=byte (base64 encoded) | bytes | +| 'string' with format=date | timestamp (google.protobuf.Timestamp) | +| 'string' with format=datetime | timestamp (google.protobuf.Timestamp) | +| 'string' with format=duration | duration (google.protobuf.Duration) | + +xref: [CEL types](https://github.com/google/cel-spec/blob/v0.6.0/doc/langdef.md#values), [OpenAPI +types](https://swagger.io/specification/#data-types), [Kubernetes Structural Schemas](https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#specifying-a-structural-schema). + + ### Defaulting From 02f63b966140f1d8ba37a17679351190049dd65d Mon Sep 17 00:00:00 2001 From: Oksana Naumov Date: Thu, 11 Nov 2021 12:01:08 -0800 Subject: [PATCH 42/68] CSI migration of Portworx is in alpha --- content/en/docs/concepts/storage/volumes.md | 10 ++++++++++ .../command-line-tools-reference/feature-gates.md | 4 ++++ 2 files changed, 14 insertions(+) diff --git a/content/en/docs/concepts/storage/volumes.md b/content/en/docs/concepts/storage/volumes.md index eb15504cde5ae..792ceae69bd34 100644 --- a/content/en/docs/concepts/storage/volumes.md +++ b/content/en/docs/concepts/storage/volumes.md @@ -1050,6 +1050,16 @@ but new volumes created by the vSphere CSI driver will not be honoring these par To turn off the `vsphereVolume` plugin from being loaded by the controller manager and the kubelet, you need to set `InTreePluginvSphereUnregister` feature flag to `true`. You must install a `csi.vsphere.vmware.com` {{< glossary_tooltip text="CSI" term_id="csi" >}} driver on all worker nodes. +#### Portworx CSI migration +{{< feature-state for_k8s_version="v1.23" state="alpha" >}} + +The `CSIMigration` feature for Portworx has been added but disabled by default in Kubernetes 1.23 since it's in alpha state. +It redirects all plugin operations from the existing in-tree plugin to the +`pxd.portworx.com` Container Storage Interface (CSI) Driver. +[Portworx CSI Driver](https://docs.portworx.com/portworx-install-with-kubernetes/storage-operations/csi/) +must be installed on the cluster. +To enable the feature, set `CSIMigrationPortworx=true` in kube-controller-manager and kubelet. + ## Using subPath {#using-subpath} Sometimes, it is useful to share one volume for multiple uses in a single pod. diff --git a/content/en/docs/reference/command-line-tools-reference/feature-gates.md b/content/en/docs/reference/command-line-tools-reference/feature-gates.md index ef806fdb6ac87..55b4316b08d4f 100644 --- a/content/en/docs/reference/command-line-tools-reference/feature-gates.md +++ b/content/en/docs/reference/command-line-tools-reference/feature-gates.md @@ -84,6 +84,7 @@ different Kubernetes components. | `CSIMigrationOpenStack` | `false` | Alpha | 1.14 | 1.17 | | `CSIMigrationOpenStack` | `true` | Beta | 1.18 | | | `CSIMigrationvSphere` | `false` | Beta | 1.19 | | +| `CSIMigrationPortworx` | `false` | Alpha | 1.23 | | | `CSIMigrationRBD` | `false` | Alpha | 1.23 | | | `CSIStorageCapacity` | `false` | Alpha | 1.19 | 1.20 | | `CSIStorageCapacity` | `true` | Beta | 1.21 | | @@ -664,6 +665,9 @@ Each feature gate is designed for enabling/disabling a specific feature: CSIMigrationvSphere feature flags enabled and vSphere CSI plugin installed and configured on all nodes in the cluster. This flag has been deprecated in favor of the `InTreePluginvSphereUnregister` feature flag which prevents the registration of in-tree vsphere plugin. +- `CSIMigrationPortworx`: Enables shims and translation logic to route volume operations + from the Portworx in-tree plugin to Portworx CSI plugin. + Requires Portworx CSI driver to be installed and configured in the cluster, and feature gate set `CSIMigrationPortworx=true` in kube-controller-manager and kubelet configs. - `CSINodeInfo`: Enable all logic related to the CSINodeInfo API object in csi.storage.k8s.io. - `CSIPersistentVolume`: Enable discovering and mounting volumes provisioned through a [CSI (Container Storage Interface)](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/storage/container-storage-interface.md) From 2ebfcfea1a96f6dec581caaa6affc534eb5c0bd8 Mon Sep 17 00:00:00 2001 From: Hemant Kumar Date: Thu, 18 Nov 2021 12:14:44 -0500 Subject: [PATCH 43/68] Update docs for ConfigurableFSGroupPolicy --- .../reference/command-line-tools-reference/feature-gates.md | 1 + .../en/docs/tasks/configure-pod-container/security-context.md | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/content/en/docs/reference/command-line-tools-reference/feature-gates.md b/content/en/docs/reference/command-line-tools-reference/feature-gates.md index 63eba752de109..9926e67e59cf5 100644 --- a/content/en/docs/reference/command-line-tools-reference/feature-gates.md +++ b/content/en/docs/reference/command-line-tools-reference/feature-gates.md @@ -222,6 +222,7 @@ different Kubernetes components. | `BoundServiceAccountTokenVolume` | `false` | Alpha | 1.13 | 1.20 | | `BoundServiceAccountTokenVolume` | `true` | Beta | 1.21 | 1.21 | | `BoundServiceAccountTokenVolume` | `true` | GA | 1.22 | - | +| `ConfigurableFSGroupPolicy` | `true` | GA | 1.23 | | | `CRIContainerLogRotation` | `false` | Alpha | 1.10 | 1.10 | | `CRIContainerLogRotation` | `true` | Beta | 1.11 | 1.20 | | `CRIContainerLogRotation` | `true` | GA | 1.21 | - | diff --git a/content/en/docs/tasks/configure-pod-container/security-context.md b/content/en/docs/tasks/configure-pod-container/security-context.md index 56bcc0f3f9211..ef78e39b6a74a 100644 --- a/content/en/docs/tasks/configure-pod-container/security-context.md +++ b/content/en/docs/tasks/configure-pod-container/security-context.md @@ -149,7 +149,7 @@ exit ## Configure volume permission and ownership change policy for Pods -{{< feature-state for_k8s_version="v1.20" state="beta" >}} +{{< feature-state for_k8s_version="v1.23" state="stable" >}} By default, Kubernetes recursively changes ownership and permissions for the contents of each volume to match the `fsGroup` specified in a Pod's `securityContext` when that volume is From 37532e231acc1d89a1e39de25a2684d655637efb Mon Sep 17 00:00:00 2001 From: Hemant Kumar Date: Thu, 18 Nov 2021 12:11:21 -0500 Subject: [PATCH 44/68] Add docs for RecoverVolumeExpansionFailure feature --- .../concepts/storage/persistent-volumes.md | 29 +++++++++++++++++++ .../admission-controllers.md | 3 +- .../feature-gates.md | 3 ++ 3 files changed, 34 insertions(+), 1 deletion(-) diff --git a/content/en/docs/concepts/storage/persistent-volumes.md b/content/en/docs/concepts/storage/persistent-volumes.md index f2093073df54a..7fae64251fc37 100644 --- a/content/en/docs/concepts/storage/persistent-volumes.md +++ b/content/en/docs/concepts/storage/persistent-volumes.md @@ -299,6 +299,11 @@ Expanding EBS volumes is a time-consuming operation. Also, there is a per-volume #### Recovering from Failure when Expanding Volumes +If a user specifies a new size that is too big to be satisfied by underlying storage system, expansion of PVC will be continuously retried until user or cluster administrator takes some action. This can be undesirable and hence Kubernetes provides following methods of recovering from such failures. + +{{< tabs name="recovery_methods" >}} +{{% tab name="Manually with Cluster Administrator access" %}} + If expanding underlying storage fails, the cluster administrator can manually recover the Persistent Volume Claim (PVC) state and cancel the resize requests. Otherwise, the resize requests are continuously retried by the controller without administrator intervention. 1. Mark the PersistentVolume(PV) that is bound to the PersistentVolumeClaim(PVC) with `Retain` reclaim policy. @@ -307,6 +312,30 @@ If expanding underlying storage fails, the cluster administrator can manually re 4. Re-create the PVC with smaller size than PV and set `volumeName` field of the PVC to the name of the PV. This should bind new PVC to existing PV. 5. Don't forget to restore the reclaim policy of the PV. +{{% /tab %}} +{{% tab name="By requesting expansion to smaller size" %}} +{{% feature-state for_k8s_version="v1.23" state="alpha" %}} + +{{< note >}} +Recovery from failing PVC expansion by users is available as an alpha feature since Kubernetes 1.23. The `RecoverVolumeExpansionFailure` feature must be enabled for this feature to work. Refer to the [feature gate](/docs/reference/command-line-tools-reference/feature-gates/) documentation for more information. +{{< /note >}} + +If the feature gates `ExpandPersistentVolumes` and `RecoverVolumeExpansionFailure` are both +enabled in your cluster, and expansion has failed for a PVC, you can retry expansion with a +smaller size than the previously requested value. To request a new expansion attempt with a +smaller proposed size, edit `.spec.resources` for that PVC and choose a value that is less than the +value you previously tried. +This is useful if expansion to a higher value did not succeed because of capacity constraint. +If that has happened, or you suspect that it might have, you can retry expansion by specifying a +size that is within the capacity limits of underlying storage provider. You can monitor status of resize operation by watching `.status.resizeStatus` and events on the PVC. + +Note that, +although you can a specify a lower amount of storage than what was requested previously, +the new value must still be higher than `.status.capacity`. +Kubernetes does not support shrinking a PVC to less than its current size. +{{% /tab %}} +{{% /tabs %}} + ## Types of Persistent Volumes diff --git a/content/en/docs/reference/access-authn-authz/admission-controllers.md b/content/en/docs/reference/access-authn-authz/admission-controllers.md index 7957ff7a4fcfa..5e5d143ccff92 100644 --- a/content/en/docs/reference/access-authn-authz/admission-controllers.md +++ b/content/en/docs/reference/access-authn-authz/admission-controllers.md @@ -583,7 +583,8 @@ subresource of the referenced *owner* can change it. This admission controller implements additional validations for checking incoming `PersistentVolumeClaim` resize requests. {{< note >}} -Support for volume resizing is available as an alpha feature. Admins must set the feature gate `ExpandPersistentVolumes` +Support for volume resizing is available as a beta feature. As a cluster administrator, +you must ensure that the feature gate `ExpandPersistentVolumes` is set to `true` to enable resizing. {{< /note >}} diff --git a/content/en/docs/reference/command-line-tools-reference/feature-gates.md b/content/en/docs/reference/command-line-tools-reference/feature-gates.md index 63eba752de109..05e55ab486146 100644 --- a/content/en/docs/reference/command-line-tools-reference/feature-gates.md +++ b/content/en/docs/reference/command-line-tools-reference/feature-gates.md @@ -165,6 +165,7 @@ different Kubernetes components. | `ProxyTerminatingEndpoints` | `false` | Alpha | 1.22 | | | `QOSReserved` | `false` | Alpha | 1.11 | | | `ReadWriteOncePod` | `false` | Alpha | 1.22 | | +| `RecoverVolumeExpansionFailure` | `false` | Alpha | 1.23 | | | `RemainingItemCount` | `false` | Alpha | 1.15 | 1.15 | | `RemainingItemCount` | `true` | Beta | 1.16 | | | `RemoveSelfLink` | `false` | Alpha | 1.16 | 1.19 | @@ -889,6 +890,8 @@ Each feature gate is designed for enabling/disabling a specific feature: (memory only for now). - `ReadWriteOncePod`: Enables the usage of `ReadWriteOncePod` PersistentVolume access mode. +- `RecoverVolumeExpansionFailure`: Enables users to edit their PVCs to smaller sizes so as they can recover from previously issued + volume expansion failures. See [enhancement proposal](https://github.com/kubernetes/enhancements/blob/master/keps/sig-storage/1790-recover-resize-failure/README.md) for more details. - `RemainingItemCount`: Allow the API servers to show a count of remaining items in the response to a [chunking list request](/docs/reference/using-api/api-concepts/#retrieving-large-results-sets-in-chunks). From 014f73f326689c433b34660be914913e67306556 Mon Sep 17 00:00:00 2001 From: Bridget Kromhout Date: Mon, 29 Nov 2021 15:41:43 -0600 Subject: [PATCH 45/68] Clarifications for dual-stack going GA in 1.23. Signed-off-by: Bridget Kromhout --- .../tools/kubeadm/dual-stack-support.md | 2 +- .../windows/intro-windows-in-kubernetes.md | 4 +--- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/content/en/docs/setup/production-environment/tools/kubeadm/dual-stack-support.md b/content/en/docs/setup/production-environment/tools/kubeadm/dual-stack-support.md index f2d250c296fba..ffd5839c23e44 100644 --- a/content/en/docs/setup/production-environment/tools/kubeadm/dual-stack-support.md +++ b/content/en/docs/setup/production-environment/tools/kubeadm/dual-stack-support.md @@ -71,7 +71,7 @@ Run kubeadm to initiate the dual-stack control plane node: kubeadm init --config=kubeadm-config.yaml ``` -Currently, the kube-controller-manager flags `--node-cidr-mask-size-ipv4|--node-cidr-mask-size-ipv6` are being left with default values. See [enable IPv4/IPv6 dual stack](/docs/concepts/services-networking/dual-stack#enable-ipv4ipv6-dual-stack). +The kube-controller-manager flags `--node-cidr-mask-size-ipv4|--node-cidr-mask-size-ipv6` are set with default values. See [configure IPv4/IPv6 dual stack](/docs/concepts/services-networking/dual-stack#configure-ipv4-ipv6-dual-stack). {{< note >}} The `--apiserver-advertise-address` flag does not support dual-stack. 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 c2160e330fae0..68ea3ee146c4e 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 @@ -340,9 +340,7 @@ Kubernetes on Windows does not support single-stack "IPv6-only" networking. Howe dual-stack IPv4/IPv6 networking for pods and nodes with single-family services is supported. -You can enable IPv4/IPv6 dual-stack networking for `l2bridge` networks using the -`IPv6DualStack` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/). -See [enable IPv4/IPv6 dual stack](/docs/concepts/services-networking/dual-stack#enable-ipv4ipv6-dual-stack) for more details. +You can use IPv4/IPv6 dual-stack networking with `l2bridge` networks. See [configure IPv4/IPv6 dual stack](/docs/concepts/services-networking/dual-stack#configure-ipv4-ipv6-dual-stack) for more details. {{< note >}} Overlay (VXLAN) networks on Windows do not support dual-stack networking. From 22475d9cf190c9cf641e192c0e8ad7cd0397012d Mon Sep 17 00:00:00 2001 From: Hemant Kumar Date: Mon, 29 Nov 2021 21:29:57 -0500 Subject: [PATCH 46/68] Update content/en/docs/reference/command-line-tools-reference/feature-gates.md Co-authored-by: Tim Bannister --- .../reference/command-line-tools-reference/feature-gates.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/content/en/docs/reference/command-line-tools-reference/feature-gates.md b/content/en/docs/reference/command-line-tools-reference/feature-gates.md index 05e55ab486146..ebed2123e5a0f 100644 --- a/content/en/docs/reference/command-line-tools-reference/feature-gates.md +++ b/content/en/docs/reference/command-line-tools-reference/feature-gates.md @@ -891,7 +891,9 @@ Each feature gate is designed for enabling/disabling a specific feature: - `ReadWriteOncePod`: Enables the usage of `ReadWriteOncePod` PersistentVolume access mode. - `RecoverVolumeExpansionFailure`: Enables users to edit their PVCs to smaller sizes so as they can recover from previously issued - volume expansion failures. See [enhancement proposal](https://github.com/kubernetes/enhancements/blob/master/keps/sig-storage/1790-recover-resize-failure/README.md) for more details. + volume expansion failures. See + [Recovering from Failure when Expanding Volumes](/docs/concepts/storage/persistent-volumes/#recovering-from-failure-when-expanding-volumes) + for more details. - `RemainingItemCount`: Allow the API servers to show a count of remaining items in the response to a [chunking list request](/docs/reference/using-api/api-concepts/#retrieving-large-results-sets-in-chunks). From 9bef88f0084e2d3c1e43741f70a916f88635c85d Mon Sep 17 00:00:00 2001 From: Ayushman Mishra Date: Tue, 30 Nov 2021 09:18:11 +0530 Subject: [PATCH 47/68] Edited FlexVolume deprecated Signed-off-by: Ayushman Mishra --- content/en/docs/concepts/extend-kubernetes/_index.md | 4 +++- content/en/docs/concepts/storage/persistent-volumes.md | 3 ++- content/en/docs/reference/glossary/flexvolume.md | 4 ++-- .../tools/kubeadm/troubleshooting-kubeadm.md | 1 + 4 files changed, 8 insertions(+), 4 deletions(-) diff --git a/content/en/docs/concepts/extend-kubernetes/_index.md b/content/en/docs/concepts/extend-kubernetes/_index.md index 825484f50d9d9..edb550bbeda4b 100644 --- a/content/en/docs/concepts/extend-kubernetes/_index.md +++ b/content/en/docs/concepts/extend-kubernetes/_index.md @@ -77,7 +77,7 @@ failure. In the webhook model, Kubernetes makes a network request to a remote service. In the *Binary Plugin* model, Kubernetes executes a binary (program). Binary plugins are used by the kubelet (e.g. -[Flex Volume Plugins](/docs/concepts/storage/volumes/#flexVolume) +[Flex Volume Plugins](/docs/concepts/storage/volumes/#flexvolume) and [Network Plugins](/docs/concepts/extend-kubernetes/compute-storage-net/network-plugins/)) and by kubectl. @@ -163,6 +163,8 @@ After a request is authorized, if it is a write operation, it also goes through ) allow users to mount volume types without built-in support by having the Kubelet call a Binary Plugin to mount the volume. +FlexVolume is deprecated in v1.23. Out-of-tree CSI driver is the recommended way to write volume drivers in Kubernetes. See this doc [here](https://github.com/kubernetes/community/blob/master/sig-storage/volume-plugin-faq.md#kubernetes-volume-plugin-faq-for-storage-vendors) for more information. + ### Device Plugins diff --git a/content/en/docs/concepts/storage/persistent-volumes.md b/content/en/docs/concepts/storage/persistent-volumes.md index f2093073df54a..8e8a6241ca867 100644 --- a/content/en/docs/concepts/storage/persistent-volumes.md +++ b/content/en/docs/concepts/storage/persistent-volumes.md @@ -318,7 +318,8 @@ PersistentVolume types are implemented as plugins. Kubernetes currently supports * [`cephfs`](/docs/concepts/storage/volumes/#cephfs) - CephFS volume * [`csi`](/docs/concepts/storage/volumes/#csi) - Container Storage Interface (CSI) * [`fc`](/docs/concepts/storage/volumes/#fc) - Fibre Channel (FC) storage -* [`flexVolume`](/docs/concepts/storage/volumes/#flexVolume) - FlexVolume +* [`flexVolume`](/docs/concepts/storage/volumes/#flexvolume) - FlexVolume + (**deprecated** in v1.23) * [`gcePersistentDisk`](/docs/concepts/storage/volumes/#gcepersistentdisk) - GCE Persistent Disk * [`glusterfs`](/docs/concepts/storage/volumes/#glusterfs) - Glusterfs volume * [`hostPath`](/docs/concepts/storage/volumes/#hostpath) - HostPath volume diff --git a/content/en/docs/reference/glossary/flexvolume.md b/content/en/docs/reference/glossary/flexvolume.md index 91478fd1f071b..aa885000c8626 100644 --- a/content/en/docs/reference/glossary/flexvolume.md +++ b/content/en/docs/reference/glossary/flexvolume.md @@ -4,14 +4,14 @@ id: flexvolume date: 2018-06-25 full_link: /docs/concepts/storage/volumes/#flexvolume short_description: > - FlexVolume is an interface for creating out-of-tree volume plugins. The {{< glossary_tooltip text="Container Storage Interface" term_id="csi" >}} is a newer interface which addresses several problems with FlexVolumes. + FlexVolume is an interface for creating out-of-tree volume plugins. It is deprecated in v1.23. The {{< glossary_tooltip text="Container Storage Interface" term_id="csi" >}} is a newer interface which addresses several problems with FlexVolumes. aka: tags: - storage --- - FlexVolume is an interface for creating out-of-tree volume plugins. The {{< glossary_tooltip text="Container Storage Interface" term_id="csi" >}} is a newer interface which addresses several problems with FlexVolumes. + FlexVolume is an interface for creating out-of-tree volume plugins. It is deprecated in v1.23. The {{< glossary_tooltip text="Container Storage Interface" term_id="csi" >}} is a newer interface which addresses several problems with FlexVolumes. 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 d0498b0c0d792..25a2e648155d2 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 @@ -375,6 +375,7 @@ For [flex-volume support](https://github.com/kubernetes/community/blob/ab55d85/c Kubernetes components like the kubelet and kube-controller-manager use the default path of `/usr/libexec/kubernetes/kubelet-plugins/volume/exec/`, yet the flex-volume directory _must be writeable_ for the feature to work. +(**Note** FlexVolume is deprecated in v1.23) To workaround this issue you can configure the flex-volume directory using the kubeadm [configuration file](/docs/reference/config-api/kubeadm-config.v1beta3/). From 26aa51a940923b7718f04891bb53532490960769 Mon Sep 17 00:00:00 2001 From: Sascha Grunert Date: Tue, 23 Nov 2021 09:58:06 +0100 Subject: [PATCH 48/68] Add CRI architecture to cluster concepts Signed-off-by: Sascha Grunert --- content/en/docs/concepts/architecture/cri.md | 51 +++++++++++++++++++ .../glossary/container-runtime-interface.md | 22 ++++++++ 2 files changed, 73 insertions(+) create mode 100644 content/en/docs/concepts/architecture/cri.md create mode 100644 content/en/docs/reference/glossary/container-runtime-interface.md diff --git a/content/en/docs/concepts/architecture/cri.md b/content/en/docs/concepts/architecture/cri.md new file mode 100644 index 0000000000000..e8391ca34b025 --- /dev/null +++ b/content/en/docs/concepts/architecture/cri.md @@ -0,0 +1,51 @@ +--- +title: Container Runtime Interface (CRI) +content_type: concept +weight: 50 +--- + + + +The CRI is a plugin interface which enables the kubelet to use a wide variety of +container runtimes, without having a need to recompile the cluster components. + +You need a working +{{}} on +each Node in your cluster, so that the +{{< glossary_tooltip text="kubelet" term_id="kubelet" >}} can launch +{{< glossary_tooltip text="Pods" term_id="pod" >}} and their containers. + +{{< glossary_definition term_id="container-runtime-interface" length="all" >}} + + + +## The API {#api} + +{{< feature-state for_k8s_version="v1.23" state="stable" >}} + +The kubelet acts as a client when connecting to the container runtime via gRPC. +The runtime and image service endpoints have to be available in the container +runtime, which can be configured separately within the kubelet by using the +`--image-service-endpoint` and `--container-runtime-endpoint` [command line +flags](/docs/reference/command-line-tools-reference/kubelet) + +For Kubernetes v{{< skew currentVersion >}}, the kubelet prefers to use CRI `v1`. +If a container runtime does not support `v1` of the CRI, then the kubelet tries to +negotiate any older supported version. +The v{{< skew currentVersion >}} kubelet can also negotiate CRI `v1alpha2`, but +this version is considered as deprecated. +If the kubelet cannot negotiate a supported CRI version, the kubelet gives up +and doesn't register as a node. + +## Upgrading + +When upgrading Kubernetes, then the kubelet tries to automatically select the +latest CRI version on restart of the component. If that fails, then the fallback +will take place as mentioned above. If a gRPC re-dial was required because the +container runtime has been upgraded, then the container runtime must also +support the initially selected version or the redial is expected to fail. This +requires a restart of the kubelet. + +## {{% heading "whatsnext" %}} + +- Learn more about the CRI [protocol definition](https://github.com/kubernetes/cri-api/blob/c75ef5b/pkg/apis/runtime/v1/api.proto) diff --git a/content/en/docs/reference/glossary/container-runtime-interface.md b/content/en/docs/reference/glossary/container-runtime-interface.md new file mode 100644 index 0000000000000..11f7bc50f4cfc --- /dev/null +++ b/content/en/docs/reference/glossary/container-runtime-interface.md @@ -0,0 +1,22 @@ +--- +title: Container Runtime Interface +id: container-runtime-interface +date: 2021-11-24 +full_link: /docs/concepts/architecture/cri +short_description: > + The main protocol for the communication between the kubelet and Container Runtime. + +aka: +tags: + - cri +--- + +The main protocol for the communication between the kubelet and Container Runtime. + + + +The Kubernetes Container Runtime Interface (CRI) defines the main +[gRPC](https://grpc.io) protocol for the communication between the +[cluster components](/docs/concepts/overview/components/#node-components) +{{< glossary_tooltip text="kubelet" term_id="kubelet" >}} and +{{< glossary_tooltip text="container runtime" term_id="container-runtime" >}}. From f7f336cf14fc47806c90178fe92c8b833e44fe04 Mon Sep 17 00:00:00 2001 From: Mike Dame Date: Thu, 11 Nov 2021 09:48:52 -0500 Subject: [PATCH 49/68] Add docs on scheduler MultiPoint config --- .../en/docs/reference/scheduling/config.md | 182 ++++++++++++++++++ 1 file changed, 182 insertions(+) diff --git a/content/en/docs/reference/scheduling/config.md b/content/en/docs/reference/scheduling/config.md index bce8d36b5c7f0..204d4124ee8de 100644 --- a/content/en/docs/reference/scheduling/config.md +++ b/content/en/docs/reference/scheduling/config.md @@ -78,6 +78,8 @@ extension points: least one bind plugin is required. 1. `postBind`: This is an informational extension point that is called after a Pod has been bound. +1. `multiPoint`: This is a config-only field that allows plugins to be enabled + or disabled for all of their applicable extension points simultaneously. For each extension point, you could disable specific [default plugins](#scheduling-plugins) or enable your own. For example: @@ -251,6 +253,186 @@ the same configuration parameters (if applicable). This is because the scheduler only has one pending pods queue. {{< /note >}} +### Plugins that apply to multiple extension points {#multipoint} + +Starting from `kubescheduler.config.k8s.io/v1beta3`, there is an additional field in the +profile config, `multiPoint`, which allows for easily enabling or disabling a plugin +across several extension points. The intent of `multiPoint` config is to simplify the +configuration needed for users and administrators when using custom profiles. + +Consider a plugin, `MyPlugin`, which implements the `preScore`, `score`, `preFilter`, +and `filter` extension points. To enable `MyPlugin` for all its available extension +points, the profile config looks like: + +```yaml +apiVersion: kubescheduler.config.k8s.io/v1beta3 +kind: KubeSchedulerConfiguration +profiles: + - schedulerName: multipoint-scheduler + plugins: + multiPoint: + enabled: + - name: MyPlugin +``` + +This would equate to manually enabling `MyPlugin` for all of its extension +points, like so: + +```yaml +apiVersion: kubescheduler.config.k8s.io/v1beta3 +kind: KubeSchedulerConfiguration +profiles: + - schedulerName: non-multipoint-scheduler + plugins: + preScore: + enabled: + - name: MyPlugin + score: + enabled: + - name: MyPlugin + preFilter: + enabled: + - name: MyPlugin + filter: + enabled: + - name: MyPlugin +``` + +One benefit of using `multiPoint` here is that if `MyPlugin` implements another +extension point in the future, the `multiPoint` config will automatically enable it +for the new extension. + +Specific extension points can be excluded from `MultiPoint` expansion using +the `disabled` field for that extension point. This works with disabling default +plugins, non-default plugins, or with the wildcard (`'*'`) to disable all plugins. +An example of this, disabling `Score` and `PreScore`, would be: + +```yaml +apiVersion: kubescheduler.config.k8s.io/v1beta3 +kind: KubeSchedulerConfiguration +profiles: + - schedulerName: non-multipoint-scheduler + plugins: + multiPoint: + enabled: + - name: 'MyPlugin' + preScore: + disabled: + - name: '*' + score: + disabled: + - name: '*' +``` + +In `v1beta3`, all [default plugins](#scheduling-plugins) are enabled internally through `MultiPoint`. +However, individual extension points are still available to allow flexible +reconfiguration of the default values (such as ordering and Score weights). For +example, consider two Score plugins `DefaultScore1` and `DefaultScore2`, each with +a weight of `1`. They can be reordered with different weights like so: + +```yaml +apiVersion: kubescheduler.config.k8s.io/v1beta3 +kind: KubeSchedulerConfiguration +profiles: + - schedulerName: multipoint-scheduler + plugins: + score: + enabled: + - name: 'DefaultScore2' + weight: 5 +``` + +In this example, it's unnecessary to specify the plugins in `MultiPoint` explicitly +because they are default plugins. And the only plugin specified in `Score` is `DefaultScore2`. +This is because plugins set through specific extension points will always take precedence +over `MultiPoint` plugins. So, this snippet essentially re-orders the two plugins +without needing to specify both of them. + +The general hierarchy for precedence when configuring `MultiPoint` plugins is as follows: +1. Specific extension points run first, and their settings override whatever is set elsewhere +2. Plugins manually configured through `MultiPoint` and their settings +3. Default plugins and their default settings + +To demonstrate the above hierarchy, the following example is based on these plugins: +|Plugin|Extension Points| +|---|---| +|`DefaultQueueSort`|`QueueSort`| +|`CustomQueueSort`|`QueueSort`| +|`DefaultPlugin1`|`Score`, `Filter`| +|`DefaultPlugin2`|`Score`| +|`CustomPlugin1`|`Score`, `Filter`| +|`CustomPlugin2`|`Score`, `Filter`| + +A valid sample configuration for these plugins would be: + +```yaml +apiVersion: kubescheduler.config.k8s.io/v1beta3 +kind: KubeSchedulerConfiguration +profiles: + - schedulerName: multipoint-scheduler + plugins: + multiPoint: + enabled: + - name: 'CustomQueueSort' + - name: 'CustomPlugin1' + weight: 3 + - name: 'CustomPlugin2' + disabled: + - name: 'DefaultQueueSort' + filter: + disabled: + - name: 'DefaultPlugin1' + score: + enabled: + - name: 'DefaultPlugin2' +``` + +Note that there is no error for re-declaring a `MultiPoint` plugin in a specific +extension point. The re-declaration is ignored (and logged), as specific extension points +take precedence. + +Besides keeping most of the config in one spot, this sample does a few things: +* Enables the custom `queueSort` plugin and disables the default one +* Enables `CustomPlugin1` and `CustomPlugin2`, which will run first for all of their extension points +* Disables `DefaultPlugin1`, but only for `filter` +* Reorders `DefaultPlugin2` to run first in `score` (even before the custom plugins) + +In versions of the config before `v1beta3`, without `multiPoint`, the above snippet would equate to this: +```yaml +apiVersion: kubescheduler.config.k8s.io/v1beta2 +kind: KubeSchedulerConfiguration +profiles: + - schedulerName: multipoint-scheduler + plugins: + + # Disable the default QueueSort plugin + queueSort: + enabled: + - name: 'CustomQueueSort' + disabled: + - name: 'DefaultQueueSort' + + # Enable custom Filter plugins + filter: + enabled: + - name: 'CustomPlugin1' + - name: 'CustomPlugin2' + - name: 'DefaultPlugin2' + disabled: + - name: 'DefaultPlugin1' + + # Enable and reorder custom score plugins + score: + enabled: + - name: 'DefaultPlugin2' + weight: 1 + - name: 'DefaultPlugin1' + weight: 3 +``` + +While this is a complicated example, it demonstrates the flexibility of `MultiPoint` config +as well as its seamless integration with the existing methods for configuring extension points. + ## Scheduler configuration migrations {{< tabs name="tab_with_md" >}} From 41547099c4a76d558bdbf07507ec192913590007 Mon Sep 17 00:00:00 2001 From: Jefftree Date: Tue, 23 Nov 2021 14:14:36 -0800 Subject: [PATCH 50/68] Add section for OpenAPI v3 --- .../docs/concepts/overview/kubernetes-api.md | 56 ++++++++++++++++++- 1 file changed, 54 insertions(+), 2 deletions(-) diff --git a/content/en/docs/concepts/overview/kubernetes-api.md b/content/en/docs/concepts/overview/kubernetes-api.md index 07b5d559d7294..e1ddda4267f0c 100644 --- a/content/en/docs/concepts/overview/kubernetes-api.md +++ b/content/en/docs/concepts/overview/kubernetes-api.md @@ -37,8 +37,11 @@ if you are writing an application using the Kubernetes API. Complete API details are documented using [OpenAPI](https://www.openapis.org/). -The Kubernetes API server serves an OpenAPI spec via the `/openapi/v2` endpoint. -You can request the response format using request headers as follows: +### OpenAPI V2 + +The Kubernetes API server serves an aggregated OpenAPI v2 spec via the +`/openapi/v2` endpoint. You can request the response format using +request headers as follows: @@ -77,6 +80,55 @@ about this format, see the [Kubernetes Protobuf serialization](https://github.co Interface Definition Language (IDL) files for each schema located in the Go packages that define the API objects. +### OpenAPI V3 + +{{< feature-state state="alpha" for_k8s_version="v1.23" >}} + +Kubernetes v1.23 offers initial support for publishing its APIs as OpenAPI v3; this is an +alpha feature that is disabled by default. +You can enable the alpha feature by turning on the +[feature gate](/docs/reference/command-line-tools-reference/feature-gates/) named `OpenAPIV3` +for the kube-apiserver component. + +With the feature enabled, the Kubernetes API server serves an +aggregated OpenAPI v3 spec per Kubernetes group version at the +`/openapi/v3/apis//` endpoint. Please refer to the +table below for accepted request headers. + +
Valid request header values for OpenAPI v2 queries
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Valid request header values for OpenAPI v3 queries
HeaderPossible valuesNotes
Accept-Encodinggzipnot supplying this header is also acceptable
Acceptapplication/com.github.proto-openapi.spec.v3@v1.0+protobufmainly for intra-cluster use
application/jsondefault
*serves application/json
+ +A discovery endpoint `/openapi/v3` is provided to see a list of all +group/versions available. This endpoint only returns JSON. + ## Persistence Kubernetes stores the serialized state of objects by writing them into From 89e744666c9e2062ac39691d2855d7b962feca23 Mon Sep 17 00:00:00 2001 From: ravisantoshgudimetla Date: Tue, 23 Nov 2021 08:13:06 -0500 Subject: [PATCH 51/68] [docs][windows]: Pod OS field update Co-authored-by: James Sturtevant Co-authored-by: Tim Bannister --- .../feature-gates.md | 3 ++ .../windows/intro-windows-in-kubernetes.md | 31 +++++++++++++++++++ .../windows/user-guide-windows-containers.md | 16 +++++++++- 3 files changed, 49 insertions(+), 1 deletion(-) diff --git a/content/en/docs/reference/command-line-tools-reference/feature-gates.md b/content/en/docs/reference/command-line-tools-reference/feature-gates.md index 81e53092cb88f..9c582b1472033 100644 --- a/content/en/docs/reference/command-line-tools-reference/feature-gates.md +++ b/content/en/docs/reference/command-line-tools-reference/feature-gates.md @@ -120,6 +120,7 @@ different Kubernetes components. | `GracefulNodeShutdown` | `true` | Beta | 1.21 | | | `HPAContainerMetrics` | `false` | Alpha | 1.20 | | | `HPAScaleToZero` | `false` | Alpha | 1.16 | | +| `IdentifyPodOS` | `false` | Alpha | 1.23 | | | `IndexedJob` | `false` | Alpha | 1.21 | 1.21 | | `IndexedJob` | `true` | Beta | 1.22 | | | `InTreePluginAWSUnregister` | `false` | Alpha | 1.21 | | @@ -779,6 +780,8 @@ Each feature gate is designed for enabling/disabling a specific feature: - `HyperVContainer`: Enable [Hyper-V isolation](https://docs.microsoft.com/en-us/virtualization/windowscontainers/manage-containers/hyperv-container) for Windows containers. +- `IdentifyPodOS`: Allows the Pod OS field to be specified. This helps in identifying the OS of the pod + authoritatively during the API server admission time. In Kubernetes {{< skew currentVersion >}}, the allowed values for the `pod.spec.os.name` are `windows` and `linux`. - `ImmutableEphemeralVolumes`: Allows for marking individual Secrets and ConfigMaps as immutable for better safety and performance. - `InTreePluginAWSUnregister`: Stops registering the aws-ebs in-tree plugin in kubelet 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 c2160e330fae0..1140403fd73d9 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 @@ -153,6 +153,37 @@ section refers to several key workload enablers and how they map to Windows. * `emptyDir` volumes * Named pipe host mounts * Resource limits + * OS field: + {{< feature-state for_k8s_version="v1.23" state="alpha" >}} + `.spec.os.name` should be set to `windows` to indicate that the current Pod uses Windows containers. + `IdentifyPodOS` feature gate needs to be enabled for this field to be recognized and used by control plane + components and kubelet. + {{< note >}} + If the `IdentifyPodOS` feature gate is enabled and you set the `.spec.os.name` field to `windows`, you must not set the following fields in the `.spec` of that Pod: + * `spec.hostPID` + * `spec.hostIPC` + * `spec.securityContext.seLinuxOptions` + * `spec.securityContext.seccompProfile` + * `spec.securityContext.fsGroup` + * `spec.securityContext.fsGroupChangePolicy` + * `spec.securityContext.sysctls` + * `spec.shareProcessNamespace` + * `spec.securityContext.runAsUser` + * `spec.securityContext.runAsGroup` + * `spec.securityContext.supplementalGroups` + * `spec.containers[*].securityContext.seLinuxOptions` + * `spec.containers[*].securityContext.seccompProfile` + * `spec.containers[*].securityContext.capabilities` + * `spec.containers[*].securityContext.readOnlyRootFilesystem` + * `spec.containers[*].securityContext.privileged` + * `spec.containers[*].securityContext.allowPrivilegeEscalation` + * `spec.containers[*].securityContext.procMount` + * `spec.containers[*].securityContext.runAsUser` + * `spec.containers[*].securityContext.runAsGroup` + + Note: In this table, wildcards (*) indicate all elements in a list. For example, spec.containers[*].securityContext refers to the Security Context object for all defined containers. If not, Pod API validation would fail causing admission failures. + {{< /note >}} + * [Workload resources](/docs/concepts/workloads/controllers/) including: * ReplicaSet * Deployments 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 ec47f5637a791..177f7623f6488 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 @@ -160,7 +160,21 @@ Users today need to use some combination of taints and node selectors in order t keep Linux and Windows workloads on their respective OS-specific nodes. This likely imposes a burden only on Windows users. The recommended approach is outlined below, with one of its main goals being that this approach should not break compatibility for existing Linux workloads. - + {{< note >}} +If the `IdentifyPodOS` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/) is +enabled, you can (and should) set `.spec.os.name` for a Pod to indicate the operating system +that the containers in that Pod are designed for. For Pods that run Linux containers, set +`.spec.os.name` to `linux`. For Pods that run Windows containers, set `.spec.os.name` +to Windows. + +The scheduler does not use the value of `.spec.os.name` when assigning Pods to nodes. You should +use normal Kubernetes mechanisms for +[assigning pods to nodes](/docs/concepts/scheduling-eviction/assign-pod-node/) +to ensure that the control plane for your cluster places pods onto nodes that are running the +appropriate operating system. + no effect on the scheduling of the Windows pods, so taints and tolerations and node selectors are still required + to ensure that the Windows pods land onto appropriate Windows nodes. + {{< /note >}} ### Ensuring OS-specific workloads land on the appropriate container host Users can ensure Windows containers can be scheduled on the appropriate host using Taints and Tolerations. From ef6668539c37efab4338ff05728fcdd3d97c2bc1 Mon Sep 17 00:00:00 2001 From: Sergey Kanzhelev Date: Tue, 30 Nov 2021 19:37:31 +0000 Subject: [PATCH 52/68] gRPC probes --- .../_posts/2018-10-01-health-checking-grpc.md | 2 + .../feature-gates.md | 10 ++-- ...igure-liveness-readiness-startup-probes.md | 50 ++++++++++++++++++- .../en/examples/pods/probe/grpc-liveness.yaml | 15 ++++++ 4 files changed, 71 insertions(+), 6 deletions(-) create mode 100644 content/en/examples/pods/probe/grpc-liveness.yaml diff --git a/content/en/blog/_posts/2018-10-01-health-checking-grpc.md b/content/en/blog/_posts/2018-10-01-health-checking-grpc.md index 21eb668dc23a9..e6e584b27479f 100644 --- a/content/en/blog/_posts/2018-10-01-health-checking-grpc.md +++ b/content/en/blog/_posts/2018-10-01-health-checking-grpc.md @@ -4,6 +4,8 @@ title: 'Health checking gRPC servers on Kubernetes' date: 2018-10-01 --- +_Built-in gRPC probes were introduced in Kubernetes 1.23. To learn more, see [Configure Liveness, Readiness and Startup Probes](/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#define-a-grpc-liveness-probe)._ + **Author**: [Ahmet Alp Balkan](https://twitter.com/ahmetb) (Google) [gRPC](https://grpc.io) is on its way to becoming the lingua franca for diff --git a/content/en/docs/reference/command-line-tools-reference/feature-gates.md b/content/en/docs/reference/command-line-tools-reference/feature-gates.md index 73bf143a43009..63088e2cc26e3 100644 --- a/content/en/docs/reference/command-line-tools-reference/feature-gates.md +++ b/content/en/docs/reference/command-line-tools-reference/feature-gates.md @@ -122,6 +122,7 @@ different Kubernetes components. | `ExperimentalHostUserNamespaceDefaulting` | `false` | Beta | 1.5 | | | `GracefulNodeShutdown` | `false` | Alpha | 1.20 | 1.20 | | `GracefulNodeShutdown` | `true` | Beta | 1.21 | | +| `GRPCContainerProbe` | `false` | Alpha | 1.23 | | | `HPAContainerMetrics` | `false` | Alpha | 1.20 | | | `HPAScaleToZero` | `false` | Alpha | 1.16 | | | `IndexedJob` | `false` | Alpha | 1.21 | 1.21 | @@ -573,10 +574,10 @@ Each feature gate is designed for enabling/disabling a specific feature: extended tokens by starting `kube-apiserver` with flag `--service-account-extend-token-expiration=false`. Check [Bound Service Account Tokens](https://github.com/kubernetes/enhancements/blob/master/keps/sig-auth/1205-bound-service-account-tokens/README.md) for more details. -- `ControllerManagerLeaderMigration`: Enables Leader Migration for - [kube-controller-manager](/docs/tasks/administer-cluster/controller-manager-leader-migration/#initial-leader-migration-configuration) and - [cloud-controller-manager](/docs/tasks/administer-cluster/controller-manager-leader-migration/#deploy-cloud-controller-manager) which allows a cluster operator to live migrate - controllers from the kube-controller-manager into an external controller-manager +- `ControllerManagerLeaderMigration`: Enables Leader Migration for + [kube-controller-manager](/docs/tasks/administer-cluster/controller-manager-leader-migration/#initial-leader-migration-configuration) and + [cloud-controller-manager](/docs/tasks/administer-cluster/controller-manager-leader-migration/#deploy-cloud-controller-manager) which allows a cluster operator to live migrate + controllers from the kube-controller-manager into an external controller-manager (e.g. the cloud-controller-manager) in an HA cluster without downtime. - `CPUManager`: Enable container level CPU affinity support, see [CPU Management Policies](/docs/tasks/administer-cluster/cpu-management-policies/). @@ -782,6 +783,7 @@ Each feature gate is designed for enabling/disabling a specific feature: and gracefully terminate pods running on the node. See [Graceful Node Shutdown](/docs/concepts/architecture/nodes/#graceful-node-shutdown) for more details. +- `GRPCContainerProbe`: Enables gPRC probe method for {Liveness,Readiness,Startup}Probe. See [Configure Liveness, Readiness and Startup Probes](/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#define-a-grpc-liveness-probe). - `HPAContainerMetrics`: Enable the `HorizontalPodAutoscaler` to scale based on metrics from individual containers in target pods. - `HPAScaleToZero`: Enables setting `minReplicas` to 0 for `HorizontalPodAutoscaler` diff --git a/content/en/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes.md b/content/en/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes.md index d9ab2056dac80..2ef2b1368c06f 100644 --- a/content/en/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes.md +++ b/content/en/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes.md @@ -220,11 +220,57 @@ After 15 seconds, view Pod events to verify that liveness probes: kubectl describe pod goproxy ``` +## Define a gRPC liveness probe + +{{< feature-state for_k8s_version="v1.23" state="alpha" >}} + +If your application implements [gRPC Health Checking Protocol](https://github.com/grpc/grpc/blob/master/doc/health-checking.md), +kubelet can be configured to use it for application liveness checks. + +{{< codenew file="pods/probe/grpc-liveness.yaml">}} + +To use a gRPC probe, `port` must be configured. If the health endpoint is configured +on a non-default service, `service` must be configured. + +{{< note >}} +Unlike HTTP and TCP probes, named ports cannot be used and custom host cannot be configured. +{{< /note >}} + +Configuration problems (e.g. incorrect port and service, unimplemented health checking protocol) +are considered a probe failure, similar to HTTP and TCP probes. + +Before Kubernetes 1.23, gRPC health probes were often implemented using [grpc-health-probe](https://github.com/grpc-ecosystem/grpc-health-probe/), +as described in the blog post [Health checking gRPC servers on Kubernetes](/blog/2018/10/01/health-checking-grpc-servers-on-kubernetes/). +The built-in gRPC probes behavior is similar to one implemented by grpc-health-probe. +When migrating from grpc-health-probe to built-in probes, remember the following differences: + +- Built-in probes will run against pod IP, unlike grpc-health-probe that often runs against `127.0.0.1`. + Be sure to configure your gRPC endpoint to listen for pod IP address. +- Built-in probes do not currently support any authentication parameters (like `-tls`). +- There are no error codes in built-in probes. All errors are considered as probe failures. +- If `ExecProbeTimeout` feature gate is set to `false`, grpc-health-probe will NOT + respect `timeoutSeconds` setting (which defaults to 1s), + while built-in probe will fail on timeout. + +To try the gRPC liveness check, create a Pod using the command below. +In the example below, etcd pod is configured to use gRPC liveness probe. + + +```shell +kubectl apply -f https://k8s.io/examples/pods/probe/content/en/examples/pods/probe/grpc-liveness.yaml +``` + +After 15 seconds, view Pod events to verify that the liveness probes has not failed: + +```shell +kubectl describe pod etcd-with-grpc +``` + ## Use a named port You can use a named [ContainerPort](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#containerport-v1-core) -for HTTP or TCP liveness checks: +for HTTP and TCP probes. Note, gRPC probe does not support named port. ```yaml ports: @@ -349,7 +395,7 @@ This defect was corrected in Kubernetes v1.20. You may have been relying on the even without realizing it, as the default timeout is 1 second. As a cluster administrator, you can disable the [feature gate](/docs/reference/command-line-tools-reference/feature-gates/) `ExecProbeTimeout` (set it to `false`) on each kubelet to restore the behavior from older versions, then remove that override -once all the exec probes in the cluster have a `timeoutSeconds` value set. +once all the exec probes in the cluster have a `timeoutSeconds` value set. If you have pods that are impacted from the default 1 second timeout, you should update their probe timeout so that you're ready for the eventual removal of that feature gate. diff --git a/content/en/examples/pods/probe/grpc-liveness.yaml b/content/en/examples/pods/probe/grpc-liveness.yaml new file mode 100644 index 0000000000000..84d716df28009 --- /dev/null +++ b/content/en/examples/pods/probe/grpc-liveness.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Pod +metadata: + name: etcd-with-grpc +spec: + containers: + - name: etcd + image: k8s.gcr.io/etcd:3.5.1-0 + command: [ "/usr/local/bin/etcd", "--data-dir", "/var/lib/etcd", "--listen-client-urls", "http://0.0.0.0:2379", "--advertise-client-urls", "http://127.0.0.1:2379", "--log-level", "debug"] + ports: + - containerPort: 2379 + livenessProbe: + gRPC: + port: 2379 + initialDelaySeconds: 10 From 6a684469cb9fd385e61fc1f75ae6b35eef332b77 Mon Sep 17 00:00:00 2001 From: Brandon Smith Date: Tue, 30 Nov 2021 15:49:17 -0800 Subject: [PATCH 53/68] Windows HostProcess Beta 1.23 Documentation (#30391) * Added initial version change * Added more information for HostProcess in 1.23, removed content relating to 1.22 specifically. * Made containerd mention specific to 1.6 * Added note about base images and removed annotation mentions * Reworded prerequisites section. --- .../feature-gates.md | 2 +- .../create-hostprocess-pod.md | 135 ++++++++---------- 2 files changed, 64 insertions(+), 73 deletions(-) diff --git a/content/en/docs/reference/command-line-tools-reference/feature-gates.md b/content/en/docs/reference/command-line-tools-reference/feature-gates.md index b4f0b7c38c6ea..83bce338d87c3 100644 --- a/content/en/docs/reference/command-line-tools-reference/feature-gates.md +++ b/content/en/docs/reference/command-line-tools-reference/feature-gates.md @@ -203,7 +203,7 @@ different Kubernetes components. | `WinDSR` | `false` | Alpha | 1.14 | | | `WinOverlay` | `false` | Alpha | 1.14 | 1.19 | | `WinOverlay` | `true` | Beta | 1.20 | | -| `WindowsHostProcessContainers` | `false` | Alpha | 1.22 | | +| `WindowsHostProcessContainers` | `false` | Beta | 1.23 | | {{< /table >}} ### Feature gates for graduated or deprecated features diff --git a/content/en/docs/tasks/configure-pod-container/create-hostprocess-pod.md b/content/en/docs/tasks/configure-pod-container/create-hostprocess-pod.md index 2ab2bd3661edb..0c33c79552462 100644 --- a/content/en/docs/tasks/configure-pod-container/create-hostprocess-pod.md +++ b/content/en/docs/tasks/configure-pod-container/create-hostprocess-pod.md @@ -7,102 +7,84 @@ min-kubernetes-server-version: 1.22 -{{< feature-state for_k8s_version="v1.22" state="alpha" >}} +{{< feature-state for_k8s_version="v1.23" state="beta" >}} -Windows HostProcess containers enable you to run containerized -workloads on a Windows host. These containers operate as -normal processes but have access to the host network namespace, -storage, and devices when given the appropriate user privileges. +Windows HostProcess containers enable you to run containerized +workloads on a Windows host. These containers operate as +normal processes but have access to the host network namespace, +storage, and devices when given the appropriate user privileges. HostProcess containers can be used to deploy network plugins, -storage configurations, device plugins, kube-proxy, and other -components to Windows nodes without the need for dedicated proxies or +storage configurations, device plugins, kube-proxy, and other +components to Windows nodes without the need for dedicated proxies or the direct installation of host services. -Administrative tasks such as installation of security patches, event -log collection, and more can be performed without requiring cluster operators to -log onto each Window node. HostProcess containers can run as any user that is -available on the host or is in the domain of the host machine, allowing administrators -to restrict resource access through user permissions. While neither filesystem or process -isolation are supported, a new volume is created on the host upon starting the container -to give it a clean and consolidated workspace. HostProcess containers can also be built on -top of existing Windows base images and do not inherit the same -[compatibility requirements](https://docs.microsoft.com/virtualization/windowscontainers/deploy-containers/version-compatibility) -as Windows server containers, meaning that the version of the base images does not need -to match that of the host. HostProcess containers also support +Administrative tasks such as installation of security patches, event +log collection, and more can be performed without requiring cluster operators to +log onto each Window node. HostProcess containers can run as any user that is +available on the host or is in the domain of the host machine, allowing administrators +to restrict resource access through user permissions. While neither filesystem or process +isolation are supported, a new volume is created on the host upon starting the container +to give it a clean and consolidated workspace. HostProcess containers can also be built on +top of existing Windows base images and do not inherit the same +[compatibility requirements](https://docs.microsoft.com/virtualization/windowscontainers/deploy-containers/version-compatibility) +as Windows server containers, meaning that the version of the base images does not need +to match that of the host. It is, however, recommended that you use the same base image +version as your Windows Server container workloads to ensure you do not have any unused +images taking up space on the node. HostProcess containers also support [volume mounts](./create-hostprocess-pod#volume-mounts) within the container volume. ### When should I use a Windows HostProcess container? -- When you need to perform tasks which require the networking namespace of the host. +- When you need to perform tasks which require the networking namespace of the host. HostProcess containers have access to the host's network interfaces and IP addresses. - You need access to resources on the host such as the filesystem, event logs, etc. - Installation of specific device drivers or Windows services. -- Consolidation of administrative tasks and security policies. This reduces the degree of +- Consolidation of administrative tasks and security policies. This reduces the degree of privileges needed by Windows nodes. -## {{% heading "prerequisites" %}} +## {{% heading "prerequisites" %}}% version-check %}} -{{% version-check %}} +In 1.23 the HostProcess container feature is enabled by default. The kublet will +communicate with containerd directly by passing the hostprocess flag via CRI. You can use the +latest version of containerd (v1.6+) to run HostProcess containers. +[How to install containerd.](/docs/setup/production-environment/container-runtimes/#containerd) -To enable HostProcess containers while in Alpha you need to pass the following feature gate flag to -**kubelet** and **kube-apiserver**. -See [Features Gates](/docs/reference/command-line-tools-reference/feature-gates/#overview) -documentation for more details. +To *disable* HostProcess containers you need to pass the following feature gate flag to the +**kubelet** and **kube-apiserver**: -``` ---feature-gates=WindowsHostProcessContainers=true +```powershell +--feature-gates=WindowsHostProcessContainers=false ``` -You can use the latest version of Containerd (v1.5.4+) with the following settings using the containerd -v2 configuration. Add these annotations to any runtime configurations were you wish to enable the -HostProcess container feature. - +See [Features Gates](/docs/reference/command-line-tools-reference/feature-gates/#overview) +documentation for more details. -``` -[plugins] - [plugins."io.containerd.grpc.v1.cri"] - [plugins."io.containerd.grpc.v1.cri".containerd] - [plugins."io.containerd.grpc.v1.cri".containerd.default_runtime] - container_annotations = ["microsoft.com/hostprocess-container"] - pod_annotations = ["microsoft.com/hostprocess-container"] - [plugins."io.containerd.grpc.v1.cri".containerd.runtimes] - [plugins."io.containerd.grpc.v1.cri".containerd.runtimes.runhcs-wcow-process] - container_annotations = ["microsoft.com/hostprocess-container"] - pod_annotations = ["microsoft.com/hostprocess-container"] -``` -The current versions of containerd ship with a version of hcsshim that does not have support. -You will need to build a version of hcsshim from the main branch following the -[instructions in hcsshim](https://github.com/Microsoft/hcsshim/#containerd-shim). -Once the containerd shim is built you can replace the file in your contianerd installation. -For example if you followed the instructions to -[install containerd](/docs/setup/production-environment/container-runtimes/#containerd) -replace the `containerd-shim-runhcs-v1.exe` is installed at `$Env:ProgramFiles\containerd` with the newly built shim. ## Limitations -- HostProcess containers require version 1.5.4 or higher of the containerd {{< glossary_tooltip text="container runtime" term_id="container-runtime" >}}. -- As of v1.22 HostProcess pods can only contain HostProcess containers. This is a current limitation +- HostProcess containers require containerd 1.6 or higher +{{< glossary_tooltip text="container runtime" term_id="container-runtime" >}}. +- As of v1.23 HostProcess pods can only contain HostProcess containers. This is a current limitation of the Windows OS; non-privileged Windows containers cannot share a vNIC with the host IP namespace. -- HostProcess containers run as a process on the host and do not have any degree of -isolation other than resource constraints imposed on the HostProcess user account. Neither +- HostProcess containers run as a process on the host and do not have any degree of +isolation other than resource constraints imposed on the HostProcess user account. Neither filesystem or Hyper-V isolation are supported for HostProcess containers. -- Volume mounts are supported and are mounted under the container volume. -See [Volume Mounts](#volume-mounts) -- A limited set of host user accounts are available for HostProcess containers by default. +- Volume mounts are supported and are mounted under the container volume. See [Volume Mounts](#volume-mounts) +- As of 1.23, a limited set of host user accounts are available for HostProcess containers by default. See [Choosing a User Account](#choosing-a-user-account). -- Resource limits (disk, memory, cpu count) are supported in the same fashion as processes +- Resource limits (disk, memory, cpu count) are supported in the same fashion as processes on the host. -- Both Named pipe mounts and Unix domain sockets are **not** currently supported and should instead +- Both Named pipe mounts and Unix domain sockets are **not** currently supported and should instead be accessed via their path on the host (e.g. \\\\.\\pipe\\\*) ## HostProcess Pod configuration requirements -Enabling a Windows HostProcess pod requires setting the right configurations in the pod security -configuration. Of the policies defined in the [Pod Security Standards](/docs/concepts/security/pod-security-standards) -HostProcess pods are disallowed by the baseline and restricted policies. It is therefore recommended -that HostProcess pods run in alignment with the privileged profile. +Enabling a Windows HostProcess pod requires setting the right configurations in the pod security +configuration. Of the policies defined in the [Pod Security Standards](/docs/concepts/security/pod-security-standards) +HostProcess pods are disallowed by the baseline and restricted policies. It is therefore recommended +that HostProcess pods run in alignment with the privileged profile. When running under the privileged policy, here are the configurations which need to be set to enable the creation of a HostProcess pod: @@ -185,10 +167,10 @@ spec: ## Volume Mounts -HostProcess containers support the ability to mount volumes within the container volume space. -Applications running inside the container can access volume mounts directly via relative or -absolute paths. An environment variable `$CONTAINER_SANDBOX_MOUNT_POINT` is set upon container -creation and provides the absolute host path to the container volume. Relative paths are based +HostProcess containers support the ability to mount volumes within the container volume space. +Applications running inside the container can access volume mounts directly via relative or +absolute paths. As of v1.23, an environment variable `$CONTAINER_SANDBOX_MOUNT_POINT` is set upon container +creation and provides the absolute host path to the container volume. Relative paths are based upon the `Pod.containers.volumeMounts.mountPath` configuration. ### Example {#volume-mount-example} @@ -199,13 +181,22 @@ To access service account tokens the following path structures are supported wit `$CONTAINER_SANDBOX_MOUNT_POINT\var\run\secrets\kubernetes.io\serviceaccount\` +## Resource Limits + +Resource limits (disk, memory, cpu count) are applied to the job and are job wide. +For example, with a limit of 10MB set, the memory allocated for any HostProcess job object +will be capped at 10MB. This is the same behavior as other Windows container types. +These limits would be specified the same way they are currently for whatever orchestrator +or runtime is being used. The only difference is in the disk resource usage calculation +used for resource tracking due to the difference in how HostProcess containers are bootstrapped. + ## Choosing a User Account -HostProcess containers support the ability to run as one of three supported Windows service accounts: +As of 1.23, HostProcess containers support the ability to run as one of three supported Windows service accounts: -- **[LocalSystem](https://docs.microsoft.com/en-us/windows/win32/services/localsystem-account)** -- **[LocalService](https://docs.microsoft.com/en-us/windows/win32/services/localservice-account)** -- **[NetworkService](https://docs.microsoft.com/en-us/windows/win32/services/networkservice-account)** +- **[LocalSystem](https://docs.microsoft.com/windows/win32/services/localsystem-account)** +- **[LocalService](https://docs.microsoft.com/windows/win32/services/localservice-account)** +- **[NetworkService](https://docs.microsoft.com/windows/win32/services/networkservice-account)** You should select an appropriate Windows service account for each HostProcess container, aiming to limit the degree of privileges so as to avoid accidental (or even From 0cbedcfeedf1354176bddc73f1da6a62af939e50 Mon Sep 17 00:00:00 2001 From: Ayushman Mishra Date: Wed, 1 Dec 2021 18:22:19 +0530 Subject: [PATCH 54/68] changes made Signed-off-by: Ayushman Mishra changes Signed-off-by: Ayushman Mishra --- content/en/docs/concepts/extend-kubernetes/_index.md | 2 +- content/en/docs/concepts/storage/persistent-volumes.md | 4 ++-- content/en/docs/reference/glossary/flexvolume.md | 4 ++-- .../tools/kubeadm/troubleshooting-kubeadm.md | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/content/en/docs/concepts/extend-kubernetes/_index.md b/content/en/docs/concepts/extend-kubernetes/_index.md index edb550bbeda4b..35669cc9556be 100644 --- a/content/en/docs/concepts/extend-kubernetes/_index.md +++ b/content/en/docs/concepts/extend-kubernetes/_index.md @@ -163,7 +163,7 @@ After a request is authorized, if it is a write operation, it also goes through ) allow users to mount volume types without built-in support by having the Kubelet call a Binary Plugin to mount the volume. -FlexVolume is deprecated in v1.23. Out-of-tree CSI driver is the recommended way to write volume drivers in Kubernetes. See this doc [here](https://github.com/kubernetes/community/blob/master/sig-storage/volume-plugin-faq.md#kubernetes-volume-plugin-faq-for-storage-vendors) for more information. +FlexVolume is deprecated since Kubernetes v1.23. The Out-of-tree CSI driver is the recommended way to write volume drivers in Kubernetes. See [Kubernetes Volume Plugin FAQ for Storage Vendors](https://github.com/kubernetes/community/blob/master/sig-storage/volume-plugin-faq.md#kubernetes-volume-plugin-faq-for-storage-vendors) for more information. ### Device Plugins diff --git a/content/en/docs/concepts/storage/persistent-volumes.md b/content/en/docs/concepts/storage/persistent-volumes.md index 8e8a6241ca867..b5a6f234b01cf 100644 --- a/content/en/docs/concepts/storage/persistent-volumes.md +++ b/content/en/docs/concepts/storage/persistent-volumes.md @@ -318,8 +318,6 @@ PersistentVolume types are implemented as plugins. Kubernetes currently supports * [`cephfs`](/docs/concepts/storage/volumes/#cephfs) - CephFS volume * [`csi`](/docs/concepts/storage/volumes/#csi) - Container Storage Interface (CSI) * [`fc`](/docs/concepts/storage/volumes/#fc) - Fibre Channel (FC) storage -* [`flexVolume`](/docs/concepts/storage/volumes/#flexvolume) - FlexVolume - (**deprecated** in v1.23) * [`gcePersistentDisk`](/docs/concepts/storage/volumes/#gcepersistentdisk) - GCE Persistent Disk * [`glusterfs`](/docs/concepts/storage/volumes/#glusterfs) - Glusterfs volume * [`hostPath`](/docs/concepts/storage/volumes/#hostpath) - HostPath volume @@ -335,6 +333,8 @@ PersistentVolume types are implemented as plugins. Kubernetes currently supports The following types of PersistentVolume are deprecated. This means that support is still available but will be removed in a future Kubernetes release. +* [`flexVolume`](/docs/concepts/storage/volumes/#flexvolume) - FlexVolume + (**deprecated** in v1.23) * [`cinder`](/docs/concepts/storage/volumes/#cinder) - Cinder (OpenStack block storage) (**deprecated** in v1.18) * [`flocker`](/docs/concepts/storage/volumes/#flocker) - Flocker storage diff --git a/content/en/docs/reference/glossary/flexvolume.md b/content/en/docs/reference/glossary/flexvolume.md index aa885000c8626..1f54e4dc683ba 100644 --- a/content/en/docs/reference/glossary/flexvolume.md +++ b/content/en/docs/reference/glossary/flexvolume.md @@ -4,14 +4,14 @@ id: flexvolume date: 2018-06-25 full_link: /docs/concepts/storage/volumes/#flexvolume short_description: > - FlexVolume is an interface for creating out-of-tree volume plugins. It is deprecated in v1.23. The {{< glossary_tooltip text="Container Storage Interface" term_id="csi" >}} is a newer interface which addresses several problems with FlexVolumes. + FlexVolume is a deprecated interface for creating out-of-tree volume plugins. The {{< glossary_tooltip text="Container Storage Interface" term_id="csi" >}} is a newer interface that addresses several problems with FlexVolume. aka: tags: - storage --- - FlexVolume is an interface for creating out-of-tree volume plugins. It is deprecated in v1.23. The {{< glossary_tooltip text="Container Storage Interface" term_id="csi" >}} is a newer interface which addresses several problems with FlexVolumes. + FlexVolume is a deprecated interface for creating out-of-tree volume plugins. The {{< glossary_tooltip text="Container Storage Interface" term_id="csi" >}} is a newer interface that addresses several problems with FlexVolume. 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 25a2e648155d2..9108ecafcd5a1 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 @@ -375,7 +375,7 @@ For [flex-volume support](https://github.com/kubernetes/community/blob/ab55d85/c Kubernetes components like the kubelet and kube-controller-manager use the default path of `/usr/libexec/kubernetes/kubelet-plugins/volume/exec/`, yet the flex-volume directory _must be writeable_ for the feature to work. -(**Note** FlexVolume is deprecated in v1.23) +(**Note**: FlexVolume was deprecated in the Kubernetes v1.23 release) To workaround this issue you can configure the flex-volume directory using the kubeadm [configuration file](/docs/reference/config-api/kubeadm-config.v1beta3/). From 3797c338a70d1cf9ae9fda1d941ebc6cd00f99a0 Mon Sep 17 00:00:00 2001 From: Sergey Kanzhelev Date: Wed, 1 Dec 2021 18:57:07 +0000 Subject: [PATCH 55/68] grpc field name consistency --- content/en/examples/pods/probe/grpc-liveness.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/examples/pods/probe/grpc-liveness.yaml b/content/en/examples/pods/probe/grpc-liveness.yaml index 84d716df28009..578fd080a4c38 100644 --- a/content/en/examples/pods/probe/grpc-liveness.yaml +++ b/content/en/examples/pods/probe/grpc-liveness.yaml @@ -10,6 +10,6 @@ spec: ports: - containerPort: 2379 livenessProbe: - gRPC: + grpc: port: 2379 initialDelaySeconds: 10 From 40e06a6fdb055c8df1f1d362b1d1b2d12f934924 Mon Sep 17 00:00:00 2001 From: Matthew Cary Date: Thu, 3 Jun 2021 09:39:09 -0700 Subject: [PATCH 56/68] KEP 1847 Statefulset auto-delete documentation --- .../workloads/controllers/statefulset.md | 78 +++++++++++++++++++ 1 file changed, 78 insertions(+) diff --git a/content/en/docs/concepts/workloads/controllers/statefulset.md b/content/en/docs/concepts/workloads/controllers/statefulset.md index 5197fe4f20d25..07782425185d8 100644 --- a/content/en/docs/concepts/workloads/controllers/statefulset.md +++ b/content/en/docs/concepts/workloads/controllers/statefulset.md @@ -301,6 +301,84 @@ already attempted to run with the bad configuration. StatefulSet will then begin to recreate the Pods using the reverted template. +## PersistentVolumeClaim retention + +{{< feature-state for_k8s_version="v1.23" state="alpha" >}} + +The optional `.spec.persistentVolumeClaimRetentionPolicy` field controls if +and how PVCs are deleted during the lifecycle of a StatefulSet. You must enable the +`StatefulSetAutoDeletePVC` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/) +to use this field. Once enabled, there are two policies you can configure for each +StatefulSet: + +`whenDeleted` +: configures the volume retention behavior that applies when the StatefulSet is deleted + +`whenScaled` +: configures the volume retention behavior that applies when the replica count of + the StatefulSet is reduced; for example, when scaling down the set. + +For each policy that you can configure, you can set the value to either `Delete` or `Retain`. + +`Delete` +: The PVCs created from the StatefulSet `volumeClaimTemplate` are deleted for each Pod + affected by the policy. With the `whenDeleted` policy all PVCs from the + `volumeClaimTemplate` are deleted after their Pods have been deleted. With the + `whenScaled` policy, only PVCs corresponding to Pod replicas being scaled down are + deleted, after their Pods have been deleted. + +`Retain` (default) +: PVCs from the `volumeClaimTemplate` are not affected when their Pod is + deleted. This is the behavior before this new feature. + +Bear in mind that these policies **only** apply when Pods are being removed due to the +StatefulSet being deleted or scaled down. For example, if a Pod associated with a StatefulSet +fails due to node failure, and the control plane creates a replacement Pod, the StatefulSet +retains the existing PVC. The existing volume is unaffected, and the cluster will attach it to +the node where the new Pod is about to launch. + +The default for policies is `Retain`, matching the StatefulSet behavior before this new feature. + +Here is an example policy. + +```yaml +apiVersion: apps/v1 +kind: StatefulSet +... +spec: + persistentVolumeClaimRetentionPolicy: + whenDeleted: Retain + whenScaled: Delete +... +``` + +The StatefulSet {{}} adds [owner +references](/docs/concepts/overview/working-with-objects/owners-dependents/#owner-references-in-object-specifications) +to its PVCs, which are then deleted by the {{}} after the Pod is terminated. This enables the Pod to +cleanly unmount all volumes before the PVCs are deleted (and before the backing PV and +volume are deleted, depending on the retain policy). When you set the `whenDeleted` +policy to `Delete`, an owner reference to the StatefulSet instance is placed on all PVCs +associated with that StatefulSet. + +The `whenScaled` policy must delete PVCs only when a Pod is scaled down, and not when a +Pod is deleted for another reason. When reconciling, the StatefulSet controller compares +its desired replica count to the actual Pods present on the cluster. Any StatefulSet Pod +whose id greater than the replica count is condemned and marked for deletion. If the +`whenScaled` policy is `Delete`, the condemned Pods are first set as owners to the +associated StatefulSet template PVCs, before the Pod is deleted. This causes the PVCs +to be garbage collected after only the condemned Pods have terminated. + +This means that if the controller crashes and restarts, no Pod will be deleted before its +owner reference has been updated appropriate to the policy. If a condemned Pod is +force-deleted while the controller is down, the owner reference may or may not have been +set up, depending on when the controller crashed. It may take several reconcile loops to +update the owner references, so some condemned Pods may have set up owner references and +other may not. For this reason we recommend waiting for the controller to come back up, +which will verify owner references before terminating Pods. If that is not possible, the +operator should verify the owner references on PVCs to ensure the expected objects are +deleted when Pods are force-deleted. + ## {{% heading "whatsnext" %}} * Learn about [Pods](/docs/concepts/workloads/pods). From 94e62c43bf56fe4772c93a272866313186c3b24b Mon Sep 17 00:00:00 2001 From: David Porter Date: Tue, 23 Nov 2021 12:05:09 -0800 Subject: [PATCH 57/68] docs: Pod priority based graceful node shutdown Signed-off-by: David Porter --- .../en/docs/concepts/architecture/nodes.md | 98 +++++++++++++++++-- 1 file changed, 91 insertions(+), 7 deletions(-) diff --git a/content/en/docs/concepts/architecture/nodes.md b/content/en/docs/concepts/architecture/nodes.md index a57d47219e482..4b3ee0e1aa103 100644 --- a/content/en/docs/concepts/architecture/nodes.md +++ b/content/en/docs/concepts/architecture/nodes.md @@ -424,20 +424,104 @@ for gracefully terminating normal pods, and the last 10 seconds would be reserved for terminating [critical pods](/docs/tasks/administer-cluster/guaranteed-scheduling-critical-addon-pods/#marking-pod-as-critical). {{< note >}} -When pods were evicted during the graceful node shutdown, they are marked as failed. -Running `kubectl get pods` shows the status of the the evicted pods as `Shutdown`. +When pods were evicted during the graceful node shutdown, they are marked as shutdown. +Running `kubectl get pods` shows the status of the the evicted pods as `Terminated`. And `kubectl describe pod` indicates that the pod was evicted because of node shutdown: ``` -Status: Failed -Reason: Shutdown -Message: Node is shutting, evicting pods +Reason: Terminated +Message: Pod was terminated in response to imminent node shutdown. ``` -Failed pod objects will be preserved until explicitly deleted or [cleaned up by the GC](/docs/concepts/workloads/pods/pod-lifecycle/#pod-garbage-collection). -This is a change of behavior compared to abrupt node termination. {{< /note >}} +### Pod Priority based graceful node shutdown {#pod-priority-graceful-node-shutdown} + +{{< feature-state state="alpha" for_k8s_version="v1.23" >}} + +To provide more flexibility during graceful node shutdown around the ordering +of pods during shutdown, graceful node shutdown honors the PriorityClass for +Pods, provided that you enabled this feature in your cluster. The feature +allows allows cluster administers to explicitly define the ordering of pods +during graceful node shutdown based on [priority +classes](docs/concepts/scheduling-eviction/pod-priority-preemption/#priorityclass). + +The [Graceful Node Shutdown](#graceful-node-shutdown) feature, as described +above, shuts down pods in two phases, non-critical pods, followed by critical +pods. If additional flexibility is needed to explicitly define the ordering of +pods during shutdown in a more granular way, pod priority based graceful +shutdown can be used. + +When graceful node shutdown honors pod priorities, this makes it possible to do +graceful node shutdown in multiple phases, each phase shutting down a +particular priority class of pods. The kubelet can be configured with the exact +phases and shutdown time per phase. + +Assuming the following custom pod [priority +classes](docs/concepts/scheduling-eviction/pod-priority-preemption/#priorityclass) +in a cluster, + +|Pod priority class name|Pod priority class value| +|-------------------------|------------------------| +|`custom-class-a` | 100000 | +|`custom-class-b` | 10000 | +|`custom-class-c` | 1000 | +|`regular/unset` | 0 | + +Within the [kubelet configuration](/docs/reference/config-api/kubelet-config.v1beta1/#kubelet-config-k8s-io-v1beta1-KubeletConfiguration) +the settings for `shutdownGracePeriodByPodPriority` could look like: + +|Pod priority class value|Shutdown period| +|------------------------|---------------| +| 100000 |10 seconds | +| 10000 |180 seconds | +| 1000 |120 seconds | +| 0 |60 seconds | + +The corresponding kubelet config YAML configuration would be: + +```yaml +shutdownGracePeriodByPodPriority: + - priority: 100000 + shutdownGracePeriodSeconds: 10 + - priority: 10000 + shutdownGracePeriodSeconds: 180 + - priority: 1000 + shutdownGracePeriodSeconds: 120 + - priority: 0 + shutdownGracePeriodSeconds: 60 +``` + +The above table implies that any pod with priority value >= 100000 will get +just 10 seconds to stop, any pod with value >= 10000 and < 100000 will get 180 +seconds to stop, any pod with value >= 1000 and < 10000 will get 120 seconds to stop. +Finally, all other pods will get 60 seconds to stop. + +One doesn't have to specify values corresponding to all of the classes. For +example, you could instead use these settings: + +|Pod priority class value|Shutdown period| +|------------------------|---------------| +| 100000 |300 seconds | +| 1000 |120 seconds | +| 0 |60 seconds | + + +In the above case, the pods with custom-class-b will go into the same bucket +as custom-class-c for shutdown. + +If there are no pods in a particular range, then the kubelet does not wait +for pods in that priority range. Instead, the kubelet immediately skips to the +next priority class value range. + +If this feature is enabled and no configuration is provided, then no ordering +action will be taken. + +Using this feature, requires enabling the +`GracefulNodeShutdownBasedOnPodPriority` feature gate, and setting the kubelet +config's `ShutdownGracePeriodByPodPriority` to the desired configuration +containing the pod priority class values and their respective shutdown periods. + ## Swap memory management {#swap-memory} {{< feature-state state="alpha" for_k8s_version="v1.22" >}} From 4a7a977901b668a069ec573d36b6ac60fbbeb6f9 Mon Sep 17 00:00:00 2001 From: Guneetconvent2002 Date: Mon, 13 Sep 2021 17:59:53 +0530 Subject: [PATCH 58/68] Fix headings for well-known labels annotations and taints Co-authored-by: Qiming Teng Co-authored-by: Tim Bannister --- .../reference/labels-annotations-taints.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/content/en/docs/reference/labels-annotations-taints.md b/content/en/docs/reference/labels-annotations-taints.md index e2fc2b317e941..325bfc2d9feed 100644 --- a/content/en/docs/reference/labels-annotations-taints.md +++ b/content/en/docs/reference/labels-annotations-taints.md @@ -427,8 +427,18 @@ or updating objects that contain Pod templates, such as Deployments, Jobs, State See [Enforcing Pod Security at the Namespace Level](/docs/concepts/security/pod-security-admission) for more information. -## seccomp.security.alpha.kubernetes.io/pod and container.seccomp.security.alpha.kubernetes.io/[NAME] (deprecated) +## seccomp.security.alpha.kubernetes.io/pod (deprecated) {#seccomp-security-alpha-kubernetes-io-pod} -The seccomp annotations have been deprecated since Kubernetes v1.19 and will -become non-functional in v1.25. Please use the `seccompProfile` of the -`SecurityContext` instead. \ No newline at end of file +This annotation has been deprecated since Kubernetes v1.19 and will become non-functional in v1.25. +To specify security settings for a Pod, include the `securityContext` field in the Pod specification. +The [`securityContext`](/docs/reference/kubernetes-api/workload-resources/pod-v1/#security-context) field within a Pod's `.spec` defines pod-level security attributes. +When you [specify the security context for a Pod](/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod), +the settings you specify apply to all containers in that Pod. + +## container.seccomp.security.alpha.kubernetes.io/[NAME] {#container-seccomp-security-alpha-kubernetes-io} + +This annotation has been deprecated since Kubernetes v1.19 and will become non-functional in v1.25. +The tutorial [Restrict a Container's Syscalls with seccomp](/docs/tutorials/clusters/seccomp/) takes +you through the steps you follow to apply a seccomp profile to a Pod or to one of +its containers. That tutorial covers the supported mechanism for configuring seccomp in Kubernetes, +based on setting `securityContext` within the Pod's `.spec`. \ No newline at end of file From 87f371ac8d67606be55fd6cbf6643b42e4769b66 Mon Sep 17 00:00:00 2001 From: Tim Bannister Date: Wed, 1 Dec 2021 23:27:21 +0000 Subject: [PATCH 59/68] Fix typo --- .../reference/command-line-tools-reference/feature-gates.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/reference/command-line-tools-reference/feature-gates.md b/content/en/docs/reference/command-line-tools-reference/feature-gates.md index 17e28a42fe778..2f788cae34cb0 100644 --- a/content/en/docs/reference/command-line-tools-reference/feature-gates.md +++ b/content/en/docs/reference/command-line-tools-reference/feature-gates.md @@ -792,7 +792,7 @@ Each feature gate is designed for enabling/disabling a specific feature: and gracefully terminate pods running on the node. See [Graceful Node Shutdown](/docs/concepts/architecture/nodes/#graceful-node-shutdown) for more details. -- `GRPCContainerProbe`: Enables gPRC probe method for {Liveness,Readiness,Startup}Probe. See [Configure Liveness, Readiness and Startup Probes](/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#define-a-grpc-liveness-probe). +- `GRPCContainerProbe`: Enables the gRPC probe method for {Liveness,Readiness,Startup}Probe. See [Configure Liveness, Readiness and Startup Probes](/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#define-a-grpc-liveness-probe). - `HPAContainerMetrics`: Enable the `HorizontalPodAutoscaler` to scale based on metrics from individual containers in target pods. - `HPAScaleToZero`: Enables setting `minReplicas` to 0 for `HorizontalPodAutoscaler` From b90d125e1cd5cd78f75945f1d2956b268cc6542b Mon Sep 17 00:00:00 2001 From: Brandon Smith Date: Thu, 2 Dec 2021 09:45:34 -0800 Subject: [PATCH 60/68] kublet -> kubelet (#30700) --- .../tasks/configure-pod-container/create-hostprocess-pod.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/tasks/configure-pod-container/create-hostprocess-pod.md b/content/en/docs/tasks/configure-pod-container/create-hostprocess-pod.md index 0c33c79552462..e989aa868f6ef 100644 --- a/content/en/docs/tasks/configure-pod-container/create-hostprocess-pod.md +++ b/content/en/docs/tasks/configure-pod-container/create-hostprocess-pod.md @@ -45,7 +45,7 @@ privileges needed by Windows nodes. ## {{% heading "prerequisites" %}}% version-check %}} -In 1.23 the HostProcess container feature is enabled by default. The kublet will +In 1.23 the HostProcess container feature is enabled by default. The kubelet will communicate with containerd directly by passing the hostprocess flag via CRI. You can use the latest version of containerd (v1.6+) to run HostProcess containers. [How to install containerd.](/docs/setup/production-environment/container-runtimes/#containerd) From d09282b3f023b390f133f6cb7c6d5f3adfa2a67c Mon Sep 17 00:00:00 2001 From: Tim Bannister Date: Wed, 1 Dec 2021 17:18:37 +0000 Subject: [PATCH 61/68] Tweak FlexVolume deprecation text --- .../concepts/storage/persistent-volumes.md | 24 +++++++++---------- content/en/docs/concepts/storage/volumes.md | 21 +++++++++------- 2 files changed, 24 insertions(+), 21 deletions(-) diff --git a/content/en/docs/concepts/storage/persistent-volumes.md b/content/en/docs/concepts/storage/persistent-volumes.md index 619dbc8405939..ea9538b20ee2b 100644 --- a/content/en/docs/concepts/storage/persistent-volumes.md +++ b/content/en/docs/concepts/storage/persistent-volumes.md @@ -221,19 +221,19 @@ to `Retain`, including cases where you are reusing an existing PV. {{< feature-state for_k8s_version="v1.11" state="beta" >}} -Support for expanding PersistentVolumeClaims (PVCs) is now enabled by default. You can expand +Support for expanding PersistentVolumeClaims (PVCs) is enabled by default. You can expand the following types of volumes: -* gcePersistentDisk +* azureDisk +* azureFile * awsElasticBlockStore -* Cinder +* cinder (deprecated) +* {{< glossary_tooltip text="csi" term_id="csi" >}} +* flexVolume (deprecated) +* gcePersistentDisk * glusterfs * rbd -* Azure File -* Azure Disk -* Portworx -* FlexVolumes -* {{< glossary_tooltip text="CSI" term_id="csi" >}} +* portworxVolume You can only expand a PVC if its storage class's `allowVolumeExpansion` field is set to true. @@ -270,8 +270,8 @@ When a volume contains a file system, the file system is only resized when a new the PersistentVolumeClaim in `ReadWrite` mode. File system expansion is either done when a Pod is starting up or when a Pod is running and the underlying file system supports online expansion. -FlexVolumes allow resize if the driver is set with the `RequiresFSResize` capability to `true`. -The FlexVolume can be resized on Pod restart. +FlexVolumes (deprecated since Kubernetes v1.23) allow resize if the driver is configured with the +`RequiresFSResize` capability to `true`. The FlexVolume can be resized on Pod restart. #### Resizing an in-use PersistentVolumeClaim @@ -362,10 +362,10 @@ PersistentVolume types are implemented as plugins. Kubernetes currently supports The following types of PersistentVolume are deprecated. This means that support is still available but will be removed in a future Kubernetes release. -* [`flexVolume`](/docs/concepts/storage/volumes/#flexvolume) - FlexVolume - (**deprecated** in v1.23) * [`cinder`](/docs/concepts/storage/volumes/#cinder) - Cinder (OpenStack block storage) (**deprecated** in v1.18) +* [`flexVolume`](/docs/concepts/storage/volumes/#flexvolume) - FlexVolume + (**deprecated** in v1.23) * [`flocker`](/docs/concepts/storage/volumes/#flocker) - Flocker storage (**deprecated** in v1.22) * [`quobyte`](/docs/concepts/storage/volumes/#quobyte) - Quobyte volume diff --git a/content/en/docs/concepts/storage/volumes.md b/content/en/docs/concepts/storage/volumes.md index 792ceae69bd34..7a0be7e524923 100644 --- a/content/en/docs/concepts/storage/volumes.md +++ b/content/en/docs/concepts/storage/volumes.md @@ -1155,8 +1155,7 @@ To learn about requesting space using a resource specification, see ## Out-of-tree volume plugins The out-of-tree volume plugins include -{{< glossary_tooltip text="Container Storage Interface" term_id="csi" >}} (CSI) -and FlexVolume. These plugins enable storage vendors to create custom storage plugins +{{< glossary_tooltip text="Container Storage Interface" term_id="csi" >}} (CSI), and also FlexVolume (which is deprecated). These plugins enable storage vendors to create custom storage plugins without adding their plugin source code to the Kubernetes repository. Previously, all volume plugins were "in-tree". The "in-tree" plugins were built, linked, compiled, @@ -1289,16 +1288,20 @@ are listed in [Types of Volumes](#volume-types). ### flexVolume -FlexVolume is an out-of-tree plugin interface that has existed in Kubernetes -since version 1.2 (before CSI). It uses an exec-based model to interface with -drivers. The FlexVolume driver binaries must be installed in a pre-defined volume -plugin path on each node and in some cases the control plane nodes as well. +{{< feature-state for_k8s_version="v1.23" state="deprecated" >}} -Pods interact with FlexVolume drivers through the `flexvolume` in-tree volume plugin. -For more details, see the [FlexVolume](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-storage/flexvolume.md) examples. +FlexVolume is an out-of-tree plugin interface that uses an exec-based model to interface +with storage drivers. The FlexVolume driver binaries must be installed in a pre-defined +volume plugin path on each node and in some cases the control plane nodes as well. + +Pods interact with FlexVolume drivers through the `flexVolume` in-tree volume plugin. +For more details, see the FlexVolume [README](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-storage/flexvolume.md#readme) document. {{< note >}} -FlexVolume is deprecated starting v1.23. Out-of-tree CSI driver is the recommended way to write volume driver in Kubernetes. Maintainers of FlexVolume driver should implement a CSI Driver and move users of FlexVolume to CSI. Users of FlexVolume should move their workloads to CSI Driver. +FlexVolume is deprecated. Using an out-of-tree CSI driver is the recommended way to integrate external storage with Kubernetes. + +Maintainers of FlexVolume driver should implement a CSI Driver and help to migrate users of FlexVolume drivers to CSI. +Users of FlexVolume should move their workloads to use the equivalent CSI Driver. {{< /note >}} ## Mount propagation From 8a0f330654ed500520f4c34e145668dcff1ede24 Mon Sep 17 00:00:00 2001 From: Tim Bannister Date: Wed, 1 Dec 2021 23:50:18 +0000 Subject: [PATCH 62/68] Improve documentation for container probes - mention gRPC probes in concept page - revise explanation of gRPC probes in task page - general tidying --- .../concepts/workloads/pods/pod-lifecycle.md | 112 +++++++++++------- ...igure-liveness-readiness-startup-probes.md | 52 ++++---- 2 files changed, 99 insertions(+), 65 deletions(-) diff --git a/content/en/docs/concepts/workloads/pods/pod-lifecycle.md b/content/en/docs/concepts/workloads/pods/pod-lifecycle.md index 75e4a0ba34e70..5d75bba37d66d 100644 --- a/content/en/docs/concepts/workloads/pods/pod-lifecycle.md +++ b/content/en/docs/concepts/workloads/pods/pod-lifecycle.md @@ -233,57 +233,87 @@ When a Pod's containers are Ready but at least one custom condition is missing o ## Container probes -A [Probe](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#probe-v1-core) is a diagnostic +A _probe_ is a diagnostic performed periodically by the [kubelet](/docs/reference/command-line-tools-reference/kubelet/) -on a Container. To perform a diagnostic, -the kubelet calls a -[Handler](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#handler-v1-core) implemented by -the container. There are three types of handlers: +on a container. To perform a diagnostic, +the kubelet either executes code within the container, or makes +a network request. -* [ExecAction](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#execaction-v1-core): - Executes a specified command inside the container. The diagnostic - is considered successful if the command exits with a status code of 0. +### Check mechanisms {#probe-check-methods} + +There are four different ways to check a container using a probe. +Each probe must define exactly one of these four mechanisms: -* [TCPSocketAction](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#tcpsocketaction-v1-core): - Performs a TCP check against the Pod's IP address on - a specified port. The diagnostic is considered successful if the port is open. +`exec` +: Executes a specified command inside the container. The diagnostic + is considered successful if the command exits with a status code of 0. -* [HTTPGetAction](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#httpgetaction-v1-core): - Performs an HTTP `GET` request against the Pod's IP - address on a specified port and path. The diagnostic is considered successful - if the response has a status code greater than or equal to 200 and less than 400. +`grpc` +: Performs a remote procedure call using [gRPC](https://grpc.io/). + The target should implement + [gRPC health checks](https://grpc.io/grpc/core/md_doc_health-checking.html). + The diagnostic is considered successful if the `status` + of the response is `SERVING`. + gRPC probes are an alpha feature and are only available if you + enable the `GRPCContainerProbe` + [feature gate](/docs/reference/command-line-tools-reference/feature-gates/). + +`httpGet` +: Performs an HTTP `GET` request against the Pod's IP + address on a specified port and path. The diagnostic is + considered successful if the response has a status code + greater than or equal to 200 and less than 400. + +`tcpSocket` +: Performs a TCP check against the Pod's IP address on + a specified port. The diagnostic is considered successful if + the port is open. If the remote system (the container) closes + the connection immediately after it opens, this counts as healthy. + +### Probe outcome Each probe has one of three results: -* `Success`: The container passed the diagnostic. -* `Failure`: The container failed the diagnostic. -* `Unknown`: The diagnostic failed, so no action should be taken. +`Success` +: The container passed the diagnostic. -The kubelet can optionally perform and react to three kinds of probes on running -containers: +`Failure` +: The container failed the diagnostic. + +`Unknown` +: The diagnostic failed (no action should be taken, and the kubelet + will make further checks). -* `livenessProbe`: Indicates whether the container is running. If - the liveness probe fails, the kubelet kills the container, and the container - is subjected to its [restart policy](#restart-policy). If a Container does not - provide a liveness probe, the default state is `Success`. +### Types of probe -* `readinessProbe`: Indicates whether the container is ready to respond to requests. - If the readiness probe fails, the endpoints controller removes the Pod's IP - address from the endpoints of all Services that match the Pod. The default - state of readiness before the initial delay is `Failure`. If a Container does - not provide a readiness probe, the default state is `Success`. +The kubelet can optionally perform and react to three kinds of probes on running +containers: -* `startupProbe`: Indicates whether the application within the container is started. - All other probes are disabled if a startup probe is provided, until it succeeds. - If the startup probe fails, the kubelet kills the container, and the container - is subjected to its [restart policy](#restart-policy). If a Container does not - provide a startup probe, the default state is `Success`. +`livenessProbe` +: Indicates whether the container is running. If + the liveness probe fails, the kubelet kills the container, and the container + is subjected to its [restart policy](#restart-policy). If a container does not + provide a liveness probe, the default state is `Success`. + +`readinessProbe` +: Indicates whether the container is ready to respond to requests. + If the readiness probe fails, the endpoints controller removes the Pod's IP + address from the endpoints of all Services that match the Pod. The default + state of readiness before the initial delay is `Failure`. If a container does + not provide a readiness probe, the default state is `Success`. + +`startupProbe` +: Indicates whether the application within the container is started. + All other probes are disabled if a startup probe is provided, until it succeeds. + If the startup probe fails, the kubelet kills the container, and the container + is subjected to its [restart policy](#restart-policy). If a container does not + provide a startup probe, the default state is `Success`. For more information about how to set up a liveness, readiness, or startup probe, see [Configure Liveness, Readiness and Startup Probes](/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/). -### When should you use a liveness probe? +#### When should you use a liveness probe? {{< feature-state for_k8s_version="v1.0" state="stable" >}} @@ -295,7 +325,7 @@ with the Pod's `restartPolicy`. If you'd like your container to be killed and restarted if a probe fails, then specify a liveness probe, and specify a `restartPolicy` of Always or OnFailure. -### When should you use a readiness probe? +#### When should you use a readiness probe? {{< feature-state for_k8s_version="v1.0" state="stable" >}} @@ -329,7 +359,7 @@ The Pod remains in the unready state while it waits for the containers in the Po to stop. {{< /note >}} -### When should you use a startup probe? +#### When should you use a startup probe? {{< feature-state for_k8s_version="v1.20" state="stable" >}} @@ -451,13 +481,13 @@ This avoids a resource leak as Pods are created and terminated over time. ## {{% heading "whatsnext" %}} * Get hands-on experience - [attaching handlers to Container lifecycle events](/docs/tasks/configure-pod-container/attach-handler-lifecycle-event/). + [attaching handlers to container lifecycle events](/docs/tasks/configure-pod-container/attach-handler-lifecycle-event/). * Get hands-on experience [configuring Liveness, Readiness and Startup Probes](/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/). * Learn more about [container lifecycle hooks](/docs/concepts/containers/container-lifecycle-hooks/). -* For detailed information about Pod / Container status in the API, see [PodStatus](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#podstatus-v1-core) -and -[ContainerStatus](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#containerstatus-v1-core). +* For detailed information about Pod and container status in the API, see + the API reference documentation covering + [`.status`](/docs/reference/kubernetes-api/workload-resources/pod-v1/#PodStatus) for Pod. diff --git a/content/en/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes.md b/content/en/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes.md index 2ef2b1368c06f..155378730185b 100644 --- a/content/en/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes.md +++ b/content/en/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes.md @@ -226,51 +226,56 @@ kubectl describe pod goproxy If your application implements [gRPC Health Checking Protocol](https://github.com/grpc/grpc/blob/master/doc/health-checking.md), kubelet can be configured to use it for application liveness checks. +You must enable the `GRPCContainerProbe` +[feature gate](/docs/reference/command-line-tools-reference/feature-gates/) +in order to configure checks that rely on gRPC. + +Here is an example manifest: {{< codenew file="pods/probe/grpc-liveness.yaml">}} To use a gRPC probe, `port` must be configured. If the health endpoint is configured -on a non-default service, `service` must be configured. +on a non-default service, you must also specify the `service`. {{< note >}} Unlike HTTP and TCP probes, named ports cannot be used and custom host cannot be configured. {{< /note >}} -Configuration problems (e.g. incorrect port and service, unimplemented health checking protocol) +Configuration problems (for example: incorrect port and service, unimplemented health checking protocol) are considered a probe failure, similar to HTTP and TCP probes. -Before Kubernetes 1.23, gRPC health probes were often implemented using [grpc-health-probe](https://github.com/grpc-ecosystem/grpc-health-probe/), -as described in the blog post [Health checking gRPC servers on Kubernetes](/blog/2018/10/01/health-checking-grpc-servers-on-kubernetes/). -The built-in gRPC probes behavior is similar to one implemented by grpc-health-probe. -When migrating from grpc-health-probe to built-in probes, remember the following differences: - -- Built-in probes will run against pod IP, unlike grpc-health-probe that often runs against `127.0.0.1`. - Be sure to configure your gRPC endpoint to listen for pod IP address. -- Built-in probes do not currently support any authentication parameters (like `-tls`). -- There are no error codes in built-in probes. All errors are considered as probe failures. -- If `ExecProbeTimeout` feature gate is set to `false`, grpc-health-probe will NOT - respect `timeoutSeconds` setting (which defaults to 1s), - while built-in probe will fail on timeout. - To try the gRPC liveness check, create a Pod using the command below. -In the example below, etcd pod is configured to use gRPC liveness probe. - +In the example below, the etcd pod is configured to use gRPC liveness probe. ```shell kubectl apply -f https://k8s.io/examples/pods/probe/content/en/examples/pods/probe/grpc-liveness.yaml ``` -After 15 seconds, view Pod events to verify that the liveness probes has not failed: +After 15 seconds, view Pod events to verify that the liveness check has not failed: ```shell kubectl describe pod etcd-with-grpc ``` +Before Kubernetes 1.23, gRPC health probes were often implemented using [grpc-health-probe](https://github.com/grpc-ecosystem/grpc-health-probe/), +as described in the blog post [Health checking gRPC servers on Kubernetes](/blog/2018/10/01/health-checking-grpc-servers-on-kubernetes/). +The built-in gRPC probes behavior is similar to one implemented by grpc-health-probe. +When migrating from grpc-health-probe to built-in probes, remember the following differences: + +- Built-in probes run against the pod IP address, unlike grpc-health-probe that often runs against `127.0.0.1`. + Be sure to configure your gRPC endpoint to listen on the Pod's IP address. +- Built-in probes do not support any authentication parameters (like `-tls`). +- There are no error codes for built-in probes. All errors are considered as probe failures. +- If `ExecProbeTimeout` feature gate is set to `false`, grpc-health-probe does **not** respect the `timeoutSeconds` setting (which defaults to 1s), + while built-in probe would fail on timeout. + ## Use a named port You can use a named -[ContainerPort](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#containerport-v1-core) -for HTTP and TCP probes. Note, gRPC probe does not support named port. +[`port`](/docs/reference/kubernetes-api/workload-resources/pod-v1/#ports) +for HTTP and TCP probes. (gRPC probes do not support named ports). + +For example: ```yaml ports: @@ -533,12 +538,11 @@ It will be rejected by the API server. ## {{% heading "whatsnext" %}} - * Learn more about [Container Probes](/docs/concepts/workloads/pods/pod-lifecycle/#container-probes). You can also read the API references for: -* [Pod](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#pod-v1-core) -* [Container](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#container-v1-core) -* [Probe](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#probe-v1-core) +* [Pod](/docs/reference/kubernetes-api/workload-resources/pod-v1/), and specifically: + * [container(s)](/docs/reference/kubernetes-api/workload-resources/pod-v1/#Container) + * [probe(s)](/docs/reference/kubernetes-api/workload-resources/pod-v1/#Probe) From e1bf8f22b24413038dde4327c7a766676beba3b6 Mon Sep 17 00:00:00 2001 From: Tim Bannister Date: Tue, 23 Nov 2021 17:18:57 +0000 Subject: [PATCH 63/68] Improve docs for HorizontalPodAutoscaler Co-authored-by: Chris Negus --- .../horizontal-pod-autoscale-walkthrough.md | 160 ++++++---- .../horizontal-pod-autoscale.md | 288 ++++++++++-------- 2 files changed, 261 insertions(+), 187 deletions(-) diff --git a/content/en/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough.md b/content/en/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough.md index f5582b9416a0d..02018745d406b 100644 --- a/content/en/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough.md +++ b/content/en/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough.md @@ -4,42 +4,59 @@ reviewers: - jszczepkowski - justinsb - directxman12 -title: Horizontal Pod Autoscaler Walkthrough +title: HorizontalPodAutoscaler Walkthrough content_type: task weight: 100 +min-kubernetes-server-version: 1.23 --- -Horizontal Pod Autoscaler automatically scales the number of Pods -in a replication controller, deployment, replica set or stateful set based on observed CPU utilization -(or, with beta support, on some other, application-provided metrics). +A [HorizontalPodAutoscaler](/docs/tasks/run-application/horizontal-pod-autoscale/) +(HPA for short) +automatically updates a workload resource (such as +a {{< glossary_tooltip text="Deployment" term_id="deployment" >}} or +{{< glossary_tooltip text="StatefulSet" term_id="statefulset" >}}), with the +aim of automatically scaling the workload to match demand. -This document walks you through an example of enabling Horizontal Pod Autoscaler for the php-apache server. -For more information on how Horizontal Pod Autoscaler behaves, see the -[Horizontal Pod Autoscaler user guide](/docs/tasks/run-application/horizontal-pod-autoscale/). +Horizontal scaling means that the response to increased load is to deploy more +{{< glossary_tooltip text="Pods" term_id="pod" >}}. +This is different from _vertical_ scaling, which for Kubernetes would mean +assigning more resources (for example: memory or CPU) to the Pods that are already +running for the workload. + +If the load decreases, and the number of Pods is above the configured minimum, +the HorizontalPodAutoscaler instructs the workload resource (the Deployment, StatefulSet, +or other similar resource) to scale back down. + +This document walks you through an example of enabling HorizontalPodAutoscaler to +automatically manage scale for an example web app. This example workload is Apache +httpd running some PHP code. ## {{% heading "prerequisites" %}} -This example requires a running Kubernetes cluster and kubectl, version 1.2 or later. -[Metrics server](https://github.com/kubernetes-sigs/metrics-server) monitoring needs to be deployed -in the cluster to provide metrics through the [Metrics API](https://github.com/kubernetes/metrics). -Horizontal Pod Autoscaler uses this API to collect metrics. To learn how to deploy the metrics-server, -see the [metrics-server documentation](https://github.com/kubernetes-sigs/metrics-server#deployment). +{{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} If you're running an older +release of Kubernetes, refer to the version of the documentation for that release (see +[available documentation versions](/docs/home/supported-doc-versions/). + +To follow this walkthrough, you also need to use a cluster that has a +[Metrics Server](https://github.com/kubernetes-sigs/metrics-server#readme) deployed and configured. +The Kubernetes Metrics Server collects resource metrics from +the {{}} in your cluster, and exposes those metrics +through the [Kubernetes API](/docs/concepts/overview/kubernetes-api/), +using an [APIService](/docs/concepts/extend-kubernetes/api-extension/apiserver-aggregation/) to add +new kinds of resource that represent metric readings. -To specify multiple resource metrics for a Horizontal Pod Autoscaler, you must have a -Kubernetes cluster and kubectl at version 1.6 or later. To make use of custom metrics, your cluster -must be able to communicate with the API server providing the custom Metrics API. -Finally, to use metrics not related to any Kubernetes object you must have a -Kubernetes cluster at version 1.10 or later, and you must be able to communicate -with the API server that provides the external Metrics API. -See the [Horizontal Pod Autoscaler user guide](/docs/tasks/run-application/horizontal-pod-autoscale/#support-for-custom-metrics) for more details. +To learn how to deploy the Metrics Server, see the +[metrics-server documentation](https://github.com/kubernetes-sigs/metrics-server#deployment). ## Run and expose php-apache server -To demonstrate Horizontal Pod Autoscaler we will use a custom docker image based on the php-apache image. The Dockerfile has the following content: +To demonstrate a HorizontalPodAutoscaler, you will first make a custom container image that uses +the `php-apache` image from Docker Hub as its starting point. The `Dockerfile` is ready-made for you, +and has the following content: ```dockerfile FROM php:5-apache @@ -47,7 +64,8 @@ COPY index.php /var/www/html/index.php RUN chmod a+rx index.php ``` -It defines an index.php page which performs some CPU intensive computations: +This code defines a simple `index.php` page that performs some CPU intensive computations, +in order to simulate load in your cluster. ```php ``` -First, we will start a deployment running the image and expose it as a service -using the following configuration: +Once you have made that container image, start a Deployment that runs a container using the +image you made, and expose it as a {{< glossary_tooltip term_id="service">}} +using the following manifest: {{< codenew file="application/php-apache.yaml" >}} -Run the following command: +To do so, run the following command: ```shell kubectl apply -f https://k8s.io/examples/application/php-apache.yaml @@ -75,16 +94,27 @@ deployment.apps/php-apache created service/php-apache created ``` -## Create Horizontal Pod Autoscaler +## Create the HorizontalPodAutoscaler {#create-horizontal-pod-autoscaler} + +Now that the server is running, create the autoscaler using `kubectl`. There is +[`kubectl autoscale`](/docs/reference/generated/kubectl/kubectl-commands#autoscale) subcommand, +part of `kubectl`, that helps you do this. + +You will shortly run a command that creates a HorizontalPodAutoscaler that maintains +between 1 and 10 replicas of the Pods controlled by the php-apache Deployment that +you created in the first step of these instructions. + +Roughly speaking, the HPA {{}} will increase and decrease +the number of replicas (by updating the Deployment) to maintain an average CPU utilization across all Pods of 50%. +The Deployment then updates the ReplicaSet - this is part of how all Deployments work in Kubernetes - +and then the ReplicaSet either adds or removes Pods based on the change to its `.spec`. -Now that the server is running, we will create the autoscaler using -[kubectl autoscale](/docs/reference/generated/kubectl/kubectl-commands#autoscale). -The following command will create a Horizontal Pod Autoscaler that maintains between 1 and 10 replicas of the Pods -controlled by the php-apache deployment we created in the first step of these instructions. -Roughly speaking, HPA will increase and decrease the number of replicas -(via the deployment) to maintain an average CPU utilization across all Pods of 50%. Since each pod requests 200 milli-cores by `kubectl run`, this means an average CPU usage of 100 milli-cores. -See [here](/docs/tasks/run-application/horizontal-pod-autoscale/#algorithm-details) for more details on the algorithm. +See [Algorithm details](/docs/tasks/run-application/horizontal-pod-autoscale/#algorithm-details) for more details +on the algorithm. + + +Create the HorizontalPodAutoscaler: ```shell kubectl autoscale deployment php-apache --cpu-percent=50 --min=1 --max=10 @@ -94,47 +124,64 @@ kubectl autoscale deployment php-apache --cpu-percent=50 --min=1 --max=10 horizontalpodautoscaler.autoscaling/php-apache autoscaled ``` -We may check the current status of autoscaler by running: +You can check the current status of the newly-made HorizontalPodAutoscaler, by running: ```shell +# You can use "hpa" or "horizontalpodautoscaler"; either name works OK. kubectl get hpa ``` +The output is similar to: ``` NAME REFERENCE TARGET MINPODS MAXPODS REPLICAS AGE php-apache Deployment/php-apache/scale 0% / 50% 1 10 1 18s ``` -Please note that the current CPU consumption is 0% as we are not sending any requests to the server -(the ``TARGET`` column shows the average across all the pods controlled by the corresponding deployment). +(if you see other HorizontalPodAutoscalers with different names, that means they already existed, +and isn't usually a problem). + +Please note that the current CPU consumption is 0% as there are no clients sending requests to the server +(the ``TARGET`` column shows the average across all the Pods controlled by the corresponding deployment). -## Increase load +## Increase the load {#increase-load} -Now, we will see how the autoscaler reacts to increased load. -We will start a container, and send an infinite loop of queries to the php-apache service (please run it in a different terminal): +Next, see how the autoscaler reacts to increased load. +To do this, you'll start a different Pod to act as a client. The container within the client Pod +runs in an infinite loop, sending queries to the php-apache service. ```shell +# Run this in a separate terminal +# so that the load generation continues and you can carry on with the rest of the steps kubectl run -i --tty load-generator --rm --image=busybox --restart=Never -- /bin/sh -c "while sleep 0.01; do wget -q -O- http://php-apache; done" ``` -Within a minute or so, we should see the higher CPU load by executing: - +Now run: ```shell -kubectl get hpa +# type Ctrl+C to end the watch when you're ready +kubectl get hpa php-apache --watch ``` +Within a minute or so, you should see the higher CPU load; for example: + ``` NAME REFERENCE TARGET MINPODS MAXPODS REPLICAS AGE php-apache Deployment/php-apache/scale 305% / 50% 1 10 1 3m ``` +and then, more replicas. For example: +``` +NAME REFERENCE TARGET MINPODS MAXPODS REPLICAS AGE +php-apache Deployment/php-apache/scale 305% / 50% 1 10 7 3m +``` + Here, CPU consumption has increased to 305% of the request. -As a result, the deployment was resized to 7 replicas: +As a result, the Deployment was resized to 7 replicas: ```shell kubectl get deployment php-apache ``` +You should see the replica count matching the figure from the HorizontalPodAutoscaler ``` NAME READY UP-TO-DATE AVAILABLE AGE php-apache 7/7 7 7 19m @@ -146,24 +193,29 @@ of load is not controlled in any way it may happen that the final number of repl will differ from this example. {{< /note >}} -## Stop load +## Stop generating load {#stop-load} -We will finish our example by stopping the user load. +To finish the example, stop sending the load. -In the terminal where we created the container with `busybox` image, terminate +In the terminal where you created the Pod that runs a `busybox` image, terminate the load generation by typing ` + C`. -Then we will verify the result state (after a minute or so): +Then verify the result state (after a minute or so): ```shell -kubectl get hpa +# type Ctrl+C to end the watch when you're ready +kubectl get hpa php-apache --watch ``` +The output is similar to: + ``` NAME REFERENCE TARGET MINPODS MAXPODS REPLICAS AGE php-apache Deployment/php-apache/scale 0% / 50% 1 10 1 11m ``` +and the Deployment also shows that it has scaled down: + ```shell kubectl get deployment php-apache ``` @@ -173,11 +225,9 @@ NAME READY UP-TO-DATE AVAILABLE AGE php-apache 1/1 1 1 27m ``` -Here CPU utilization dropped to 0, and so HPA autoscaled the number of replicas back down to 1. +Once CPU utilization dropped to 0, the HPA automatically scaled the number of replicas back down to 1. -{{< note >}} Autoscaling the replicas may take a few minutes. -{{< /note >}} @@ -444,7 +494,7 @@ Conditions: Events: ``` -For this HorizontalPodAutoscaler, we can see several conditions in a healthy state. The first, +For this HorizontalPodAutoscaler, you can see several conditions in a healthy state. The first, `AbleToScale`, indicates whether or not the HPA is able to fetch and update scales, as well as whether or not any backoff-related conditions would prevent scaling. The second, `ScalingActive`, indicates whether or not the HPA is enabled (i.e. the replica count of the target is not zero) and @@ -454,7 +504,7 @@ was capped by the maximum or minimum of the HorizontalPodAutoscaler. This is an you may wish to raise or lower the minimum or maximum replica count constraints on your HorizontalPodAutoscaler. -## Appendix: Quantities +## Quantities All metrics in the HorizontalPodAutoscaler and metrics APIs are specified using a special whole-number notation known in Kubernetes as a @@ -464,16 +514,16 @@ will return whole numbers without a suffix when possible, and will generally ret quantities in milli-units otherwise. This means you might see your metric value fluctuate between `1` and `1500m`, or `1` and `1.5` when written in decimal notation. -## Appendix: Other possible scenarios +## Other possible scenarios ### Creating the autoscaler declaratively Instead of using `kubectl autoscale` command to create a HorizontalPodAutoscaler imperatively we -can use the following file to create it declaratively: +can use the following manifest to create it declaratively: {{< codenew file="application/hpa/php-apache.yaml" >}} -We will create the autoscaler by executing the following command: +Then, create the autoscaler by executing the following command: ```shell kubectl create -f https://k8s.io/examples/application/hpa/php-apache.yaml 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 3208035a975db..acec1e6af9d81 100644 --- a/content/en/docs/tasks/run-application/horizontal-pod-autoscale.md +++ b/content/en/docs/tasks/run-application/horizontal-pod-autoscale.md @@ -3,41 +3,59 @@ reviewers: - fgrzadkowski - jszczepkowski - directxman12 -title: Horizontal Pod Autoscaler +title: Horizontal Pod Autoscaling feature: title: Horizontal scaling description: > Scale your application up and down with a simple command, with a UI, or automatically based on CPU usage. - content_type: concept weight: 90 --- -The Horizontal Pod Autoscaler automatically scales the number of Pods -in a replication controller, deployment, replica set or stateful set based on observed CPU utilization (or, with -[custom metrics](https://git.k8s.io/community/contributors/design-proposals/instrumentation/custom-metrics-api.md) -support, on some other application-provided metrics). Note that Horizontal -Pod Autoscaling does not apply to objects that can't be scaled, for example, DaemonSets. +In Kubernetes, a _HorizontalPodAutoscaler_ automatically updates a workload resource (such as +a {{< glossary_tooltip text="Deployment" term_id="deployment" >}} or +{{< glossary_tooltip text="StatefulSet" term_id="statefulset" >}}), with the +aim of automatically scaling the workload to match demand. -The Horizontal Pod Autoscaler is implemented as a Kubernetes API resource and a controller. -The resource determines the behavior of the controller. -The controller periodically adjusts the number of replicas in a replication controller or deployment to match the observed metrics such as average CPU utilisation, average memory utilisation or any other custom metric to the target specified by the user. +Horizontal scaling means that the response to increased load is to deploy more +{{< glossary_tooltip text="Pods" term_id="pod" >}}. +This is different from _vertical_ scaling, which for Kubernetes would mean +assigning more resources (for example: memory or CPU) to the Pods that are already +running for the workload. + +If the load decreases, and the number of Pods is above the configured minimum, +the HorizontalPodAutoscaler instructs the workload resource (the Deployment, StatefulSet, +or other similar resource) to scale back down. +Horizontal pod autoscaling does not apply to objects that can't be scaled (for example: +a {{< glossary_tooltip text="DaemonSet" term_id="daemonset" >}}.) +The HorizontalPodAutoscaler is implemented as a Kubernetes API resource and a +{{< glossary_tooltip text="controller" term_id="controller" >}}. +The resource determines the behavior of the controller. +The horizontal pod autoscaling controller, running within the Kubernetes +{{< glossary_tooltip text="control plane" term_id="control-plane" >}}, periodically adjusts the +desired scale of its target (for example, a Deployment) to match observed metrics such as average +CPU utilization, average memory utilization, or any other custom metric you specify. + +There is [walkthrough example](/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough/) of using +horizontal pod autoscaling. -## How does the Horizontal Pod Autoscaler work? +## How does a HorizontalPodAutoscaler work? -![Horizontal Pod Autoscaler diagram](/images/docs/horizontal-pod-autoscaler.svg) +{{< figure src="/images/docs/horizontal-pod-autoscaler.svg" caption="HorizontalPodAutoscaler controls the scale of a Deployment and its ReplicaSet" class="diagram-medium">}} -The Horizontal Pod Autoscaler is implemented as a control loop, with a period controlled -by the controller manager's `--horizontal-pod-autoscaler-sync-period` flag (with a default -value of 15 seconds). +Kubernetes implements horizontal pod autoscaling as a control loop that runs intermittently +(it is not a continuous process). The interval is set by the +`--horizontal-pod-autoscaler-sync-period` parameter to the +[`kube-controller-manager`](/docs/reference/command-line-tools-reference/kube-controller-manager/) +(and the default interval is 15 seconds). -During each period, the controller manager queries the resource utilization against the +Once during each period, the controller manager queries the resource utilization against the metrics specified in each HorizontalPodAutoscaler definition. The controller manager obtains the metrics from either the resource metrics API (for per-pod resource metrics), or the custom metrics API (for all other metrics). @@ -45,17 +63,17 @@ or the custom metrics API (for all other metrics). * For per-pod resource metrics (like CPU), the controller fetches the metrics from the resource metrics API for each Pod targeted by the HorizontalPodAutoscaler. Then, if a target utilization value is set, the controller calculates the utilization - value as a percentage of the equivalent resource request on the containers in - each Pod. If a target raw value is set, the raw metric values are used directly. + value as a percentage of the equivalent + [resource request](/docs/concepts/configuration/manage-resources-containers/#requests-and-limits) + on the containers in each Pod. If a target raw value is set, the raw metric values are used directly. The controller then takes the mean of the utilization or the raw value (depending on the type of target specified) across all targeted Pods, and produces a ratio used to scale the number of desired replicas. Please note that if some of the Pod's containers do not have the relevant resource request set, CPU utilization for the Pod will not be defined and the autoscaler will - not take any action for that metric. See the [algorithm - details](#algorithm-details) section below for more information about - how the autoscaling algorithm works. + not take any action for that metric. See the [algorithm details](#algorithm-details) section below + for more information about how the autoscaling algorithm works. * For per-pod custom metrics, the controller functions similarly to per-pod resource metrics, except that it works with raw values, not utilization values. @@ -66,20 +84,25 @@ or the custom metrics API (for all other metrics). version, this value can optionally be divided by the number of Pods before the comparison is made. -The HorizontalPodAutoscaler normally fetches metrics from a series of aggregated APIs (`metrics.k8s.io`, -`custom.metrics.k8s.io`, and `external.metrics.k8s.io`). The `metrics.k8s.io` API is usually provided by -metrics-server, which needs to be launched separately. For more information about resource metrics, see [Metrics Server](/docs/tasks/debug-application-cluster/resource-metrics-pipeline/#metrics-server). +The common use for HorizontalPodAutoscaler is to configure it to fetch metrics from +{{< glossary_tooltip text="aggregated APIs" term_id="aggregation-layer" >}} +(`metrics.k8s.io`, `custom.metrics.k8s.io`, or `external.metrics.k8s.io`). The `metrics.k8s.io` API is +usually provided by an add on named Metrics Server, which needs to be launched separately. +For more information about resource metrics, see +[Metrics Server](/docs/tasks/debug-application-cluster/resource-metrics-pipeline/#metrics-server). -See [Support for metrics APIs](#support-for-metrics-apis) for more details. +[Support for metrics APIs](#support-for-metrics-apis) explains the stability guarantees and support status for these +different APIs. -The autoscaler accesses corresponding scalable controllers (such as replication controllers, deployments, and replica sets) -by using the scale sub-resource. Scale is an interface that allows you to dynamically set the number of replicas and examine -each of their current states. More details on scale sub-resource can be found -[here](https://git.k8s.io/community/contributors/design-proposals/autoscaling/horizontal-pod-autoscaler.md#scale-subresource). +The HorizontalPodAutoscaler controller accesses corresponding workload resources that support scaling (such as Deployments +and StatefulSet). These resources each have a subresource named `scale`, an interface that allows you to dynamically set the +number of replicas and examine each of their current states. +For general information about subresources in the Kubernetes API, see +[Kubernetes API Concepts](/docs/reference/using-api/api-concepts/). -### Algorithm Details +### Algorithm details -From the most basic perspective, the Horizontal Pod Autoscaler controller +From the most basic perspective, the HorizontalPodAutoscaler controller operates on the ratio between desired metric value and current metric value: @@ -89,26 +112,28 @@ desiredReplicas = ceil[currentReplicas * ( currentMetricValue / desiredMetricVal For example, if the current metric value is `200m`, and the desired value is `100m`, the number of replicas will be doubled, since `200.0 / 100.0 == -2.0` If the current value is instead `50m`, we'll halve the number of -replicas, since `50.0 / 100.0 == 0.5`. We'll skip scaling if the ratio is -sufficiently close to 1.0 (within a globally-configurable tolerance, from -the `--horizontal-pod-autoscaler-tolerance` flag, which defaults to 0.1). +2.0` If the current value is instead `50m`, you'll halve the number of +replicas, since `50.0 / 100.0 == 0.5`. The control plane skips any scaling +action if the ratio is sufficiently close to 1.0 (within a globally-configurable +tolerance, 0.1 by default). When a `targetAverageValue` or `targetAverageUtilization` is specified, the `currentMetricValue` is computed by taking the average of the given metric across all Pods in the HorizontalPodAutoscaler's scale target. -Before checking the tolerance and deciding on the final values, we take -pod readiness and missing metrics into consideration, however. -All Pods with a deletion timestamp set (i.e. Pods in the process of being -shut down) and all failed Pods are discarded. +Before checking the tolerance and deciding on the final values, the control +plane also considers whether any metrics are missing, and how many Pods +are [`Ready`](/docs/concepts/workloads/pods/pod-lifecycle/#pod-conditions). +All Pods with a deletion timestamp set (objects with a deletion timestamp are +in the process of being shut down / removed) are ignored, and all failed Pods +are discarded. If a particular Pod is missing metrics, it is set aside for later; Pods with missing metrics will be used to adjust the final scaling amount. -When scaling on CPU, if any pod has yet to become ready (i.e. it's still -initializing) *or* the most recent metric point for the pod was before it -became ready, that pod is set aside as well. +When scaling on CPU, if any pod has yet to become ready (it's still +initializing, or possibly is unhealthy) *or* the most recent metric point for +the pod was before it became ready, that pod is set aside as well. Due to technical constraints, the HorizontalPodAutoscaler controller cannot exactly determine the first time a pod becomes ready when @@ -124,20 +149,21 @@ default is 5 minutes. The `currentMetricValue / desiredMetricValue` base scale ratio is then calculated using the remaining pods not set aside or discarded from above. -If there were any missing metrics, we recompute the average more +If there were any missing metrics, the control plane recomputes the average more conservatively, assuming those pods were consuming 100% of the desired value in case of a scale down, and 0% in case of a scale up. This dampens the magnitude of any potential scale. -Furthermore, if any not-yet-ready pods were present, and we would have -scaled up without factoring in missing metrics or not-yet-ready pods, we -conservatively assume the not-yet-ready pods are consuming 0% of the -desired metric, further dampening the magnitude of a scale up. +Furthermore, if any not-yet-ready pods were present, and the workload would have +scaled up without factoring in missing metrics or not-yet-ready pods, +the controller conservatively assumes that the not-yet-ready pods are consuming 0% +of the desired metric, further dampening the magnitude of a scale up. -After factoring in the not-yet-ready pods and missing metrics, we -recalculate the usage ratio. If the new ratio reverses the scale -direction, or is within the tolerance, we skip scaling. Otherwise, we use -the new ratio to scale. +After factoring in the not-yet-ready pods and missing metrics, the +controller recalculates the usage ratio. If the new ratio reverses the scale +direction, or is within the tolerance, the controller doesn't take any scaling +action. In other cases, the new ratio is used to decide any change to the +number of Pods. Note that the *original* value for the average utilization is reported back via the HorizontalPodAutoscaler status, without factoring in the @@ -173,19 +199,13 @@ When you create a HorizontalPodAutoscaler API object, make sure the name specifi More details about the API object can be found at [HorizontalPodAutoscaler Object](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#horizontalpodautoscaler-v2-autoscaling). +## Stability of workload scale {#flapping} -## Support for Horizontal Pod Autoscaler in kubectl - -Horizontal Pod Autoscaler, like every API resource, is supported in a standard way by `kubectl`. -We can create a new autoscaler using `kubectl create` command. -We can list autoscalers by `kubectl get hpa` and get detailed description by `kubectl describe hpa`. -Finally, we can delete an autoscaler using `kubectl delete hpa`. +When managing the scale of a group of replicas using the HorizontalPodAutoscaler, +it is possible that the number of replicas keeps fluctuating frequently due to the +dynamic nature of the metrics evaluated. This is sometimes referred to as *thrashing*, +or *flapping*. It's similar to the concept of *hysteresis* in cybernetics. -In addition, there is a special `kubectl autoscale` command for creating a HorizontalPodAutoscaler object. -For instance, executing `kubectl autoscale rs foo --min=2 --max=5 --cpu-percent=80` -will create an autoscaler for replication set *foo*, with target CPU utilization set to `80%` -and the number of replicas between 2 and 5. -The detailed documentation of `kubectl autoscale` can be found [here](/docs/reference/generated/kubectl/kubectl-commands/#autoscale). ## Autoscaling during rolling update @@ -202,31 +222,6 @@ If you perform a rolling update of a StatefulSet that has an autoscaled number o replicas, the StatefulSet directly manages its set of Pods (there is no intermediate resource similar to ReplicaSet). -## Support for cooldown/delay - -When managing the scale of a group of replicas using the Horizontal Pod Autoscaler, -it is possible that the number of replicas keeps fluctuating frequently due to the -dynamic nature of the metrics evaluated. This is sometimes referred to as *thrashing*. - -Starting from v1.6, a cluster operator can mitigate this problem by tuning -the global HPA settings exposed as flags for the `kube-controller-manager` component: - -Starting from v1.12, a new algorithmic update removes the need for the -upscale delay. - -- `--horizontal-pod-autoscaler-downscale-stabilization`: Specifies the duration of the - downscale stabilization time window. Horizontal Pod Autoscaler remembers - the historical recommended sizes and only acts on the largest size within this time window. - The default value is 5 minutes (`5m0s`). - -{{< note >}} -When tuning these parameter values, a cluster operator should be aware of the possible -consequences. If the delay (cooldown) value is set too long, there could be complaints -that the Horizontal Pod Autoscaler is not responsive to workload changes. However, if -the delay value is set too short, the scale of the replicas set may keep thrashing as -usual. -{{< /note >}} - ## Support for resource metrics Any HPA target can be scaled based on the resource usage of the pods in the scaling target. @@ -255,11 +250,11 @@ a single container might be running with high usage and the HPA will not scale o pod usage is still within acceptable limits. {{< /note >}} -### Container Resource Metrics +### Container resource metrics {{< feature-state for_k8s_version="v1.20" state="alpha" >}} -`HorizontalPodAutoscaler` also supports a container metric source where the HPA can track the +The HorizontalPodAutoscaler API also supports a container metric source where the HPA can track the resource usage of individual containers across a set of Pods, in order to scale the target resource. This lets you configure scaling thresholds for the containers that matter most in a particular Pod. For example, if you have a web application and a logging sidecar, you can scale based on the resource @@ -271,6 +266,7 @@ scaling. If the specified container in the metric source is not present or only of the pods then those pods are ignored and the recommendation is recalculated. See [Algorithm](#algorithm-details) for more details about the calculation. To use container resources for autoscaling define a metric source as follows: + ```yaml type: ContainerResource containerResource: @@ -296,30 +292,32 @@ Once you have rolled out the container name change to the workload resource, tid the old container name from the HPA specification. {{< /note >}} -## Support for multiple metrics -Kubernetes 1.6 adds support for scaling based on multiple metrics. You can use the `autoscaling/v2` API -version to specify multiple metrics for the Horizontal Pod Autoscaler to scale on. Then, the Horizontal Pod -Autoscaler controller will evaluate each metric, and propose a new scale based on that metric. The largest of the -proposed scales will be used as the new scale. +## Scaling on custom metrics -## Support for custom metrics +{{< feature-state for_k8s_version="v1.23" state="stable" >}} -{{< note >}} -Kubernetes 1.2 added alpha support for scaling based on application-specific metrics using special annotations. -Support for these annotations was removed in Kubernetes 1.6 in favor of the new autoscaling API. While the old method for collecting -custom metrics is still available, these metrics will not be available for use by the Horizontal Pod Autoscaler, and the former -annotations for specifying which custom metrics to scale on are no longer honored by the Horizontal Pod Autoscaler controller. -{{< /note >}} +(the `autoscaling/v2beta2` API version previously provided this ability as a beta feature) -You can also use a HorizontalPodAutoscaler to change the scale of a -workload based on custom metrics. You can add custom metrics for the -Horizontal Pod Autoscaler to use in the `autoscaling/v2` API. -Kubernetes then queries the new custom metrics API to fetch the values -of the appropriate custom metrics. +Provided that you use the `autoscaling/v2` API version, you can configure a HorizontalPodAutoscaler +to scale based on a custom metric (that is not built in to Kubernetes or any Kubernetes component). +The HorizontalPodAutoscaler controller then queries for these custom metrics from the Kubernetes +API. See [Support for metrics APIs](#support-for-metrics-apis) for the requirements. +## Scaling on multiple metrics + +{{< feature-state for_k8s_version="v1.23" state="stable" >}} + +(the `autoscaling/v2beta2` API version previously provided this ability as a beta feature) + +Provided that you use the `autoscaling/v2` API version, you can specify multiple metrics for a +HorizontalPodAutoscaler to scale on. Then, the HorizontalPodAutoscaler controller evaluates each metric, +and proposes a new scale based on that metric. The HorizontalPodAutoscaler takes the maximum scale +recommended for each metric and sets the workload to that size (provided that this isn't larger than the +overall maximum that you configured). + ## Support for metrics APIs By default, the HorizontalPodAutoscaler controller retrieves metrics from a series of APIs. In order for it to access these @@ -333,8 +331,7 @@ APIs, cluster administrators must ensure that: It can be launched as a cluster addon. * For custom metrics, this is the `custom.metrics.k8s.io` API. It's provided by "adapter" API servers provided by metrics solution vendors. - Check with your metrics pipeline, or the [list of known solutions](https://github.com/kubernetes/metrics/blob/master/IMPLEMENTATIONS.md#custom-metrics-api). - If you would like to write your own, check out the [boilerplate](https://github.com/kubernetes-sigs/custom-metrics-apiserver) to get started. + Check with your metrics pipeline to see if there is a Kubernetes metrics adapter available. * For external metrics, this is the `external.metrics.k8s.io` API. It may be provided by the custom metrics adapters provided above. @@ -346,20 +343,23 @@ and [external.metrics.k8s.io](https://github.com/kubernetes/community/blob/maste For examples of how to use them see [the walkthrough for using custom metrics](/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough/#autoscaling-on-multiple-metrics-and-custom-metrics) and [the walkthrough for using external metrics](/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough/#autoscaling-on-metrics-not-related-to-kubernetes-objects). -## Support for configurable scaling behavior +## Configurable scaling behavior + +{{< feature-state for_k8s_version="v1.23" state="stable" >}} -Starting from -[v1.18](https://github.com/kubernetes/enhancements/blob/master/keps/sig-autoscaling/853-configurable-hpa-scale-velocity/README.md) -the `v2beta2` API (and from v1.23 the `v2` 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 window -can be specified for both directions which prevents the flapping of -the number of the replicas in the scaling target. Similarly specifying -scaling policies controls the rate of change of replicas while -scaling. +(the `autoscaling/v2beta2` API version previously provided this ability as a beta feature) -### Scaling Policies +If you use the `v2` HorizontalPodAutoscaler API, you can use the `behavior` field +(see the [API reference](/docs/reference/kubernetes-api/workload-resources/horizontal-pod-autoscaler-v2/#HorizontalPodAutoscalerSpec)) +to configure separate scale-up and scale-down behaviors. +You specify these behaviours by setting `scaleUp` and / or `scaleDown` +under the `behavior` field. + +You can specify a _stabilization window_ that prevents [flapping](#flapping) +the replica count for a scaling target. Scaling policies also let you controls the +rate of change of replicas while scaling. + +### Scaling policies One or more scaling policies can be specified in the `behavior` section of the spec. When multiple policies are specified the policy which allows the highest amount of @@ -396,21 +396,27 @@ direction. By setting the value to `Min` which would select the policy which all smallest change in the replica count. Setting the value to `Disabled` completely disables scaling in that direction. -### Stabilization Window +### Stabilization window + +The stabilization window is used to restrict the [flapping](#flapping) of +replicas count when the metrics used for scaling keep fluctuating. The autoscaling algorithm +uses this window to infer a previous desired state and avoid unwanted changes to workload +scale. -The stabilization window is used to restrict the flapping of replicas when the metrics -used for scaling keep fluctuating. The stabilization window is used by the autoscaling -algorithm to consider the computed desired state from the past to prevent scaling. In -the following example the stabilization window is specified for `scaleDown`. +For example, in the following example snippet, a stabilization window is specified for `scaleDown`. ```yaml -scaleDown: - stabilizationWindowSeconds: 300 +behavior: + scaleDown: + stabilizationWindowSeconds: 300 ``` When the metrics indicate that the target should be scaled down the algorithm looks -into previously computed desired states and uses the highest value from the specified -interval. In above example all desired states from the past 5 minutes will be considered. +into previously computed desired states, and uses the highest value from the specified +interval. In the above example, all desired states from the past 5 minutes will be considered. + +This approximates a rolling maximum, and avoids having the scaling algorithm frequently +remove Pods only to trigger recreating an equivalent Pod just moments later. ### Default Behavior @@ -498,6 +504,18 @@ behavior: selectPolicy: Disabled ``` +## Support for HorizontalPodAutoscaler in kubectl + +HorizontalPodAutoscaler, like every API resource, is supported in a standard way by `kubectl`. +You can create a new autoscaler using `kubectl create` command. +You can list autoscalers by `kubectl get hpa` or get detailed description by `kubectl describe hpa`. +Finally, you can delete an autoscaler using `kubectl delete hpa`. + +In addition, there is a special `kubectl autoscale` command for creating a HorizontalPodAutoscaler object. +For instance, executing `kubectl autoscale rs foo --min=2 --max=5 --cpu-percent=80` +will create an autoscaler for replication set *foo*, with target CPU utilization set to `80%` +and the number of replicas between 2 and 5. + ## Implicit maintenance-mode deactivation You can implicitly deactivate the HPA for a target without the @@ -509,7 +527,13 @@ replica count or HPA's minimum replica count. ## {{% heading "whatsnext" %}} +If you configure autoscaling in your cluster, you may also want to consider running a +cluster-level autoscaler such as [Cluster Autoscaler](https://github.com/kubernetes/autoscaler/tree/master/cluster-autoscaler). + +For more information on HorizontalPodAutoscaler: -* Design documentation: [Horizontal Pod Autoscaling](https://git.k8s.io/community/contributors/design-proposals/autoscaling/horizontal-pod-autoscaler.md). -* kubectl autoscale command: [kubectl autoscale](/docs/reference/generated/kubectl/kubectl-commands/#autoscale). -* Usage example of [Horizontal Pod Autoscaler](/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough/). +* Read a [walkthrough example](/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough/) for horizontal pod autoscaling. +* Read documentation for [`kubectl autoscale`](/docs/reference/generated/kubectl/kubectl-commands/#autoscale). +* If you would like to write your own custom metrics adapter, check out the + [boilerplate](https://github.com/kubernetes-sigs/custom-metrics-apiserver) to get started. +* Read the [API reference](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/horizontal-pod-autoscaler/) for HorizontalPodAutoscaler. From c1af8d4c1bd5ea704765e58edd1a323f96c923cd Mon Sep 17 00:00:00 2001 From: Tim Bannister Date: Wed, 1 Dec 2021 22:33:19 +0000 Subject: [PATCH 64/68] Present scope for IngressClass params using tabs Use tabs for the two different options that an IngressClass can use to refer to another object, in order to specific parameters that relate to that IngressClass: - namespaced scope - cluster scope (the default / historical behavior) --- .../concepts/services-networking/ingress.md | 99 ++++++++++++++++--- 1 file changed, 86 insertions(+), 13 deletions(-) diff --git a/content/en/docs/concepts/services-networking/ingress.md b/content/en/docs/concepts/services-networking/ingress.md index 5f4837fa2972f..4fb7a2c215e7a 100644 --- a/content/en/docs/concepts/services-networking/ingress.md +++ b/content/en/docs/concepts/services-networking/ingress.md @@ -219,25 +219,98 @@ of the controller that should implement the class. {{< codenew file="service/networking/external-lb.yaml" >}} -IngressClass resources contain an optional parameters field. This can be used to -reference additional implementation-specific configuration for this class. +The `.spec.parameters` field of an IngressClass lets you reference another +resource that provides configuration related to that IngressClass. -#### Namespace-scoped parameters +The specific type of parameters to use depends on the ingress controller +that you specify in the `.spec.controller` field of the IngressClass. +### IngressClass scope + +Depending on your ingress controller, you may be able to use parameters +that you set cluster-wide, or just for one namespace. + +{{< tabs name="tabs_ingressclass_parameter_scope" >}} +{{% tab name="Cluster" %}} +The default scope for IngressClass parameters is cluster-wide. + +If you set the `.spec.parameters` field and don't set +`.spec.parameters.scope`, or if you set `.spec.parameters.scope` to +`Cluster`, then the IngressClass refers to a cluster-scoped resource. +The `kind` (in combination the `apiGroup`) of the parameters +refers to a cluster-scoped API (possibly a custom resource), and +the `name` of the parameters identifies a specific cluster scoped +resource for that API. + +For example: +```yaml +--- +apiVersion: networking.k8s.io/v1 +kind: IngressClass +metadata: + name: external-lb-1 +spec: + controller example.com/ingress-controller + parameters: + # The parameters for this IngressClass are specified in an + # ClusterIngressParameter (API group k8s.example.net) named + # "external-config-1". This definition tells Kubernetes to + # look for a cluster-scoped parameter resource. + scope: Cluster + apiGroup: k8s.example.net + kind: ClusterIngressParameter + name: external-config +``` +{{% /tab %}} +{{% tab name="Namespaced" %}} {{< feature-state for_k8s_version="v1.23" state="stable" >}} -`Parameters` field has a `scope` and `namespace` field that can be used to -reference a namespace-specific resource for configuration of an Ingress class. -`Scope` field defaults to `Cluster`, meaning, the default is cluster-scoped -resource. Setting `Scope` to `Namespace` and setting the `Namespace` field -will reference a parameters resource in a specific namespace: +If you set the `.spec.parameters` field and set +`.spec.parameters.scope` to `Namespace`, then the IngressClass refers +to a namespaced-scoped resource. You must also set the `namespace` +field within `.spec.parameters` to the namespace that contains +the parameters you want to use. -Namespace-scoped parameters avoid the need for a cluster-scoped CustomResourceDefinition -for a parameters resource. This further avoids RBAC-related resources -that would otherwise be required to grant permissions to cluster-scoped -resources. +The `kind` (in combination the `apiGroup`) of the parameters +refers to a namespaced API (for example: ConfigMap), and +the `name` of the parameters identifies a specific resource +in the namespace you specified in `namespace`. + +Namespace-scoped parameters help the cluster operator delegate control over the +configuration (for example: load balancer settings, API gateway definition) +that is used for a workload. If you used a cluster-scoped parameter then either: + +- the cluster operator team needs to approve a different team's changes every + time there's a new configuration change being applied. +- the cluster operator must define specific access controls, such as + [RBAC](/docs/reference/access-authn-authz/rbac/) roles and bindings, that let + the application team make changes to the cluster-scoped parameters resource. + +The IngressClass API itself is always cluster-scoped. + +Here is an example of an IngressClass that refers to parameters that are +namespaced: +```yaml +--- +apiVersion: networking.k8s.io/v1 +kind: IngressClass +metadata: + name: external-lb-2 +spec: + controller example.com/ingress-controller + parameters: + # The parameters for this IngressClass are specified in an + # IngressParameter (API group k8s.example.com) named "external-config", + # that's in the "external-configuration" configuration namespace. + scope: Namespace + apiGroup: k8s.example.com + kind: IngressParameter + namespace: external-configuration + name: external-config +``` -{{< codenew file="service/networking/namespaced-params.yaml" >}} +{{% /tab %}} +{{< /tabs >}} ### Deprecated annotation From 366ae6e48bb7c959cd2040000ab52e19dbbb5f86 Mon Sep 17 00:00:00 2001 From: Tim Bannister Date: Sun, 5 Dec 2021 22:26:49 +0000 Subject: [PATCH 65/68] Fix IngressClass tabs --- content/en/docs/concepts/services-networking/ingress.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/docs/concepts/services-networking/ingress.md b/content/en/docs/concepts/services-networking/ingress.md index 4fb7a2c215e7a..0bcacd7e20874 100644 --- a/content/en/docs/concepts/services-networking/ingress.md +++ b/content/en/docs/concepts/services-networking/ingress.md @@ -252,14 +252,14 @@ metadata: spec: controller example.com/ingress-controller parameters: - # The parameters for this IngressClass are specified in an + # The parameters for this IngressClass are specified in a # ClusterIngressParameter (API group k8s.example.net) named # "external-config-1". This definition tells Kubernetes to # look for a cluster-scoped parameter resource. scope: Cluster apiGroup: k8s.example.net kind: ClusterIngressParameter - name: external-config + name: external-config-1 ``` {{% /tab %}} {{% tab name="Namespaced" %}} From 8983d73fff36307a83df706f20c0afb57006a0b9 Mon Sep 17 00:00:00 2001 From: Tim Bannister Date: Mon, 6 Dec 2021 21:07:33 +0000 Subject: [PATCH 66/68] Tidy HostProcess task page (#30762) * Tidy HostProcess task page * Use spaces for indentation Tabs for indentation are less easy to work with between different contributors. Switch to spaces. * Fix table for HostProcess requirements --- .../create-hostprocess-pod.md | 135 ++++++++++-------- 1 file changed, 72 insertions(+), 63 deletions(-) diff --git a/content/en/docs/tasks/configure-pod-container/create-hostprocess-pod.md b/content/en/docs/tasks/configure-pod-container/create-hostprocess-pod.md index 9e18805cf8352..10052fd68e220 100644 --- a/content/en/docs/tasks/configure-pod-container/create-hostprocess-pod.md +++ b/content/en/docs/tasks/configure-pod-container/create-hostprocess-pod.md @@ -2,7 +2,7 @@ title: Create a Windows HostProcess Pod content_type: task weight: 20 -min-kubernetes-server-version: 1.22 +min-kubernetes-server-version: 1.23 --- @@ -43,9 +43,15 @@ HostProcess containers have access to the host's network interfaces and IP addre privileges needed by Windows nodes. -## {{% heading "prerequisites" %}}% version-check %}} +## {{% heading "prerequisites" %}} -In 1.23 the HostProcess container feature is enabled by default. The kubelet will + + +This task guide is specific to Kubernetes v{{< skew currentVersion >}}. +If you are not running Kubernetes v{{< skew currentVersion >}}, check the documentation for +that version of Kubernetes. + +In Kubernetes {{< skew currentVersion >}}, the HostProcess container feature is enabled by default. The kubelet will communicate with containerd directly by passing the hostprocess flag via CRI. You can use the latest version of containerd (v1.6+) to run HostProcess containers. [How to install containerd.](/docs/setup/production-environment/container-runtimes/#containerd) @@ -64,20 +70,21 @@ documentation for more details. ## Limitations +These limitations are relevant for Kubernetes v{{< skew currentVersion >}}: + - HostProcess containers require containerd 1.6 or higher {{< glossary_tooltip text="container runtime" term_id="container-runtime" >}}. -- As of v1.23 HostProcess pods can only contain HostProcess containers. This is a current limitation +- HostProcess pods can only contain HostProcess containers. This is a current limitation of the Windows OS; non-privileged Windows containers cannot share a vNIC with the host IP namespace. - HostProcess containers run as a process on the host and do not have any degree of isolation other than resource constraints imposed on the HostProcess user account. Neither filesystem or Hyper-V isolation are supported for HostProcess containers. - Volume mounts are supported and are mounted under the container volume. See [Volume Mounts](#volume-mounts) -- As of 1.23, a limited set of host user accounts are available for HostProcess containers by default. - A limited set of host user accounts are available for HostProcess containers by default. -See [Choosing a User Account](#choosing-a-user-account). + See [Choosing a User Account](#choosing-a-user-account). - Resource limits (disk, memory, cpu count) are supported in the same fashion as processes on the host. -- Both Named pipe mounts and Unix domain sockets are **not** currently supported and should instead +- Both Named pipe mounts and Unix domain sockets are **not** supported and should instead be accessed via their path on the host (e.g. \\\\.\\pipe\\\*) ## HostProcess Pod configuration requirements @@ -91,62 +98,64 @@ When running under the privileged policy, here are the configurations which need to be set to enable the creation of a HostProcess pod: - - - - - - - - - + + + + + + + + + + - - - - - +

Allowed Values

+
    +
  • true
  • +
+ + + + + + - - - + + + - - + - - +
  • false
  • + + + +
    Privileged policy specification
    ControlPolicy
    Windows HostProcess -

    Windows pods offer the ability to run +

    Privileged policy specification
    ControlPolicy
    securityContext.windowsOptions.hostProcess +

    Windows pods offer the ability to run HostProcess containers which enables privileged access to the Windows node.

    -

    Allowed Values

    -
      -
    • true
    • -
    -
    Host Networking -

    Will be in host network by default initially. Support - to set network to a different compartment may be desirable in - the future.

    -

    Allowed Values

    -
      -
    • true
    • -
    -
    hostNetwork +

    Will be in host network by default initially. Support + to set network to a different compartment may be desirable in + the future.

    +

    Allowed Values

    +
      +
    • true
    • +
    +
    runAsUsername -

    Specification of which user the HostProcess container should run as is required for the pod spec.

    -

    Allowed Values

    -
      -
    • NT AUTHORITY\SYSTEM
    • -
    • NT AUTHORITY\Local service
    • -
    • NT AUTHORITY\NetworkService
    • -
    -
    securityContext.windowsOptions.runAsUsername +

    Specification of which user the HostProcess container should run as is required for the pod spec.

    +

    Allowed Values

    +
      +
    • NT AUTHORITY\SYSTEM
    • +
    • NT AUTHORITY\Local service
    • +
    • NT AUTHORITY\NetworkService
    • +
    +
    runAsNonRoot -

    Because HostProcess containers have privileged access to the host, the runAsNonRoot field cannot be set to true.

    -

    Allowed Values

    -
      +
    runAsNonRoot +

    Because HostProcess containers have privileged access to the host, the runAsNonRoot field cannot be set to true.

    +

    Allowed Values

    +
    • Undefined/Nil
    • -
    • false
    • -
    -
    -### Example Manifest (excerpt) +### Example manifest (excerpt) {#manifest-example} ```yaml spec: @@ -166,13 +175,13 @@ spec: "kubernetes.io/os": windows ``` -## Volume Mounts +## Volume mounts HostProcess containers support the ability to mount volumes within the container volume space. Applications running inside the container can access volume mounts directly via relative or -absolute paths. As of v1.23, an environment variable `$CONTAINER_SANDBOX_MOUNT_POINT` is set upon container +absolute paths. An environment variable `$CONTAINER_SANDBOX_MOUNT_POINT` is set upon container creation and provides the absolute host path to the container volume. Relative paths are based -upon the `Pod.containers.volumeMounts.mountPath` configuration. +upon the `.spec.containers.volumeMounts.mountPath` configuration. ### Example {#volume-mount-example} @@ -182,7 +191,7 @@ To access service account tokens the following path structures are supported wit `$CONTAINER_SANDBOX_MOUNT_POINT\var\run\secrets\kubernetes.io\serviceaccount\` -## Resource Limits +## Resource limits Resource limits (disk, memory, cpu count) are applied to the job and are job wide. For example, with a limit of 10MB set, the memory allocated for any HostProcess job object @@ -191,9 +200,9 @@ These limits would be specified the same way they are currently for whatever orc or runtime is being used. The only difference is in the disk resource usage calculation used for resource tracking due to the difference in how HostProcess containers are bootstrapped. -## Choosing a User Account +## Choosing a user account -As of 1.23, HostProcess containers support the ability to run as one of three supported Windows service accounts: +HostProcess containers support the ability to run as one of three supported Windows service accounts: - **[LocalSystem](https://docs.microsoft.com/windows/win32/services/localsystem-account)** - **[LocalService](https://docs.microsoft.com/windows/win32/services/localservice-account)** From c0e8dd526b32b2963c0e5eab20120699b6ced78c Mon Sep 17 00:00:00 2001 From: Jesse Butler Date: Mon, 6 Dec 2021 18:15:42 -0500 Subject: [PATCH 67/68] update config for release 1.23 --- config.toml | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/config.toml b/config.toml index 5380a72bdff6a..c71f4fcdeafe5 100644 --- a/config.toml +++ b/config.toml @@ -186,30 +186,30 @@ docsbranch = "main" url = "https://kubernetes.io" [[params.versions]] -fullversion = "v1.22.1" +fullversion = "v1.22.4" version = "v1.22" -githubbranch = "v1.22.1" +githubbranch = "v1.22.4" docsbranch = "release-1.22" url = "https://v1-22.docs.kubernetes.io" [[params.versions]] -fullversion = "v1.21.4" +fullversion = "v1.21.7" version = "v1.21" -githubbranch = "v1.21.4" +githubbranch = "v1.21.7" docsbranch = "release-1.21" url = "https://v1-21.docs.kubernetes.io" [[params.versions]] -fullversion = "v1.20.10" +fullversion = "v1.20.13" version = "v1.20" -githubbranch = "v1.20.10" +githubbranch = "v1.20.13" docsbranch = "release-1.20" url = "https://v1-20.docs.kubernetes.io" [[params.versions]] -fullversion = "v1.19.14" +fullversion = "v1.19.16" version = "v1.19" -githubbranch = "v1.19.14" +githubbranch = "v1.19.16" docsbranch = "release-1.19" url = "https://v1-19.docs.kubernetes.io" From 8506e8b1de09f658c3f806c30a59afbf0a74b965 Mon Sep 17 00:00:00 2001 From: Jesse Butler Date: Tue, 7 Dec 2021 16:26:34 -0500 Subject: [PATCH 68/68] Generate single-page API reference for 1.23 --- .../generated/kubernetes-api/v1.23/index.html | 43998 ++++++++++++++++ .../kubernetes-api/v1.23/js/navData.js | 1 + 2 files changed, 43999 insertions(+) create mode 100644 static/docs/reference/generated/kubernetes-api/v1.23/index.html create mode 100644 static/docs/reference/generated/kubernetes-api/v1.23/js/navData.js diff --git a/static/docs/reference/generated/kubernetes-api/v1.23/index.html b/static/docs/reference/generated/kubernetes-api/v1.23/index.html new file mode 100644 index 0000000000000..1d1d5e8afc12a --- /dev/null +++ b/static/docs/reference/generated/kubernetes-api/v1.23/index.html @@ -0,0 +1,43998 @@ + + + + +Kubernetes API Reference Docs + + + + + + +
    +
    + +
    +
    + +
    +
    Generated at: 2021-12-07 16:19:07 (EST)
    +
    API Version: v1.23.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
    apiextensions.k8s.iov1
    apiregistration.k8s.iov1
    appsv1
    authentication.k8s.iov1
    authorization.k8s.iov1
    autoscalingv1, v2, v2beta2, v2beta1
    batchv1, v1beta1
    certificates.k8s.iov1
    coordination.k8s.iov1
    corev1
    discovery.k8s.iov1, v1beta1
    events.k8s.iov1, v1beta1
    flowcontrol.apiserver.k8s.iov1beta2, v1beta1
    internal.apiserver.k8s.iov1alpha1
    networking.k8s.iov1
    node.k8s.iov1, v1beta1, v1alpha1
    policyv1, v1beta1
    rbac.authorization.k8s.iov1
    scheduling.k8s.iov1
    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. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(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. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(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 Possible enum values: - `"Always"` means that kubelet always attempts to pull the latest image. Container will fail If the pull fails. - `"IfNotPresent"` means that kubelet pulls if the image isn't present on disk. Container will fail if the image isn't present and the pull fails. - `"Never"` means that kubelet never pulls an image, but only uses a local image. Container will fail if the image isn't present
    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
    SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. 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. Possible enum values: - `"FallbackToLogsOnError"` will read the most recent contents of the container logs for the container status message when the container exits with an error and the terminationMessagePath has no contents. - `"File"` is the default behavior and will set the container status message to the contents of the container's terminationMessagePath when the container exits.
    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.
    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 v1 batch

    + + + + + +
    GroupVersionKind
    batchv1CronJob
    +
    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
    +

    CronJobSpec v1 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 Possible enum values: - `"Allow"` allows CronJobs to run concurrently. - `"Forbid"` forbids concurrent runs, skipping next run if previous 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. Value must be non-negative integer. 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. Value must be non-negative integer. 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 v1 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 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
    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/v1/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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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/v1/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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    CronJob
    Created
    +

    Replace

    +

    replace the specified CronJob

    +

    HTTP Request

    +PUT /apis/batch/v1/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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    CronJob
    +

    Response

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

    Delete

    +

    delete a CronJob

    +

    HTTP Request

    +DELETE /apis/batch/v1/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/v1/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/v1/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/v1/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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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/v1/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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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/v1/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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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/v1/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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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/v1/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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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/v1/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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    CronJob
    Created
    +

    Read Status

    +

    read status of the specified CronJob

    +

    HTTP Request

    +GET /apis/batch/v1/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/v1/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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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
    numberReady is the number of nodes that should be running the daemon pod and have one or more of the daemon pod running with a Ready Condition.
    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 beta field and enabled/disabled by 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 up. 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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    DaemonSet
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    DaemonSet
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#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
    readyReplicas is the number of pods targeted by this Deployment with a Ready Condition.
    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. Possible enum values: - `"Recreate"` Kill all existing pods before creating new ones. - `"RollingUpdate"` Replace the old ReplicaSets by new one using rolling update i.e gradually scale down the old ReplicaSets and scale up the new one.
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    Deployment
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    Deployment
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    Scale
    Created
    +

    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. In addition, The Pod name takes the form `$(job-name)-$(index)-$(random-string)`, the Pod hostname takes the form `$(job-name)-$(index)`. This field is beta-level. 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. Defaults to false. This field is beta-level, gated by SuspendJob feature flag (enabled by default).
    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.
    +

    JobStatus v1 batch

    +
    Appears In: + +
    + + + + + + + + + + + + + +
    FieldDescription
    active
    integer
    The number of pending and 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.
    ready
    integer
    The number of pods which have a Ready condition. This field is alpha-level. The job controller populates the field when the feature gate JobReadyPods is enabled (disabled by default).
    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.
    uncountedTerminatedPods
    UncountedTerminatedPods
    UncountedTerminatedPods holds the UIDs of Pods that have terminated but the job controller hasn't yet accounted for in the status counters. The job controller creates pods with a finalizer. When a pod terminates (succeeded or failed), the controller does three steps to account for it in the job status: (1) Add the pod UID to the arrays in this field. (2) Remove the pod finalizer. (3) Remove the pod UID from the arrays while increasing the corresponding counter. This field is beta-level. The job controller only makes use of this field when the feature gate JobTrackingWithFinalizers is enabled (enabled by default). Old jobs might not be tracked using this field, in which case the field remains null.
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    Job
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    Job
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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'. Possible enum values: - `"ClusterFirst"` indicates that the pod should use cluster DNS first unless hostNetwork is true, if it is available, then fall back on the default (as determined by kubelet) DNS settings. - `"ClusterFirstWithHostNet"` indicates that the pod should use cluster DNS first, if it is available, then fall back on the default (as determined by kubelet) DNS settings. - `"Default"` indicates that the pod should use the default (as determined by kubelet) DNS settings. - `"None"` indicates that the pod should use empty DNS settings. DNS parameters such as nameservers and search paths should be defined via DNSConfig.
    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 beta-level and available on clusters that haven't disabled the EphemeralContainers feature gate.
    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/
    os
    PodOS
    Specifies the OS of the containers in the pod. Some pod and container fields are restricted if this is set. If the OS field is set to linux, the following fields must be unset: -securityContext.windowsOptions If the OS field is set to windows, following fields must be unset: - spec.hostPID - spec.hostIPC - spec.securityContext.seLinuxOptions - spec.securityContext.seccompProfile - spec.securityContext.fsGroup - spec.securityContext.fsGroupChangePolicy - spec.securityContext.sysctls - spec.shareProcessNamespace - spec.securityContext.runAsUser - spec.securityContext.runAsGroup - spec.securityContext.supplementalGroups - spec.containers[*].securityContext.seLinuxOptions - spec.containers[*].securityContext.seccompProfile - spec.containers[*].securityContext.capabilities - spec.containers[*].securityContext.readOnlyRootFilesystem - spec.containers[*].securityContext.privileged - spec.containers[*].securityContext.allowPrivilegeEscalation - spec.containers[*].securityContext.procMount - spec.containers[*].securityContext.runAsUser - spec.containers[*].securityContext.runAsGroup This is an alpha field and requires the IdentifyPodOS feature
    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/688-pod-overhead/README.md This field is beta-level as of Kubernetes v1.18, 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/580-pod-readiness-gates
    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 Possible enum values: - `"Always"` - `"Never"` - `"OnFailure"`
    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/585-runtime-class 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 beta-level and available on clusters that haven't disabled the EphemeralContainers feature gate.
    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 Possible enum values: - `"Failed"` means that all containers in the pod have terminated, and at least one container has terminated in a failure (exited with a non-zero exit code or was stopped by the system). - `"Pending"` means the pod has been accepted by the system, but one or more of the containers has not been started. This includes time before being bound to a node, as well as time spent pulling images onto the host. - `"Running"` means the pod has been bound to a node and all of the containers have been started. At least one container is still running or is in the process of being restarted. - `"Succeeded"` means that all containers in the pod have voluntarily terminated with a container exit code of 0, and the system is not going to restart any of these containers. - `"Unknown"` means that 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. Deprecated: It isn't being set since 2015 (74da3b14b0c0f658b3bb8d2def5094686d0e9095)
    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 Possible enum values: - `"BestEffort"` is the BestEffort qos class. - `"Burstable"` is the Burstable qos class. - `"Guaranteed"` is the Guaranteed qos class.
    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    Pod
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    Pod
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Pod
    +

    Response

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

    EphemeralContainers Operations

    +

    Patch EphemeralContainers

    +

    partially update ephemeralcontainers of the specified Pod

    +

    HTTP Request

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

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    Pod
    Created
    +

    Read EphemeralContainers

    +

    read ephemeralcontainers of the specified Pod

    +

    HTTP Request

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

    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 EphemeralContainers

    +

    replace ephemeralcontainers of the specified Pod

    +

    HTTP Request

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

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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
    readyReplicas is the number of pods targeted by this ReplicaSet with a Ready Condition.
    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    ReplicaSet
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    ReplicaSet
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    Scale
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    ReplicationController
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    ReplicationController
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    Scale
    Created
    +

    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
    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    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
    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) This is an alpha field and requires enabling StatefulSetMinReadySeconds feature gate.
    persistentVolumeClaimRetentionPolicy
    StatefulSetPersistentVolumeClaimRetentionPolicy
    persistentVolumeClaimRetentionPolicy describes the lifecycle of persistent volume claims created from volumeClaimTemplates. By default, all persistent volume claims are created as needed and retained until manually deleted. This policy allows the lifecycle to be altered, for example by deleting persistent volume claims when their stateful set is deleted, or when their pod is scaled down. This requires the StatefulSetAutoDeletePVC feature gate to be enabled, which is alpha. +optional
    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. Possible enum values: - `"OrderedReady"` will create pods in strictly increasing order on scale up and strictly decreasing order on scale down, progressing only when the previous pod is ready or terminated. At most one pod will be changed at any time. - `"Parallel"` will create and delete pods as soon as the stateful set replica count is changed, and will not wait for pods to be ready or complete termination.
    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
    availableReplicas
    integer
    Total number of available pods (ready for at least minReadySeconds) targeted by this statefulset. This is a beta field and enabled/disabled by StatefulSetMinReadySeconds feature gate.
    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 for this StatefulSet with 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
    Items is the list of stateful 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's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    StatefulSet
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    StatefulSet
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    Scale
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    Endpoints
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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 v1 discovery.k8s.io

    + + + + + +
    GroupVersionKind
    discovery.k8s.iov1EndpointSlice
    +
    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. Possible enum values: - `"FQDN"` represents a FQDN. - `"IPv4"` represents an IPv4 Address. - `"IPv6"` represents an IPv6 Address.
    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 v1 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/v1/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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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/v1/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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    EndpointSlice
    Created
    +

    Replace

    +

    replace the specified EndpointSlice

    +

    HTTP Request

    +PUT /apis/discovery.k8s.io/v1/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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    EndpointSlice
    +

    Response

    + + + + + + +
    CodeDescription
    200
    EndpointSlice
    OK
    201
    EndpointSlice
    Created
    +

    Delete

    +

    delete an EndpointSlice

    +

    HTTP Request

    +DELETE /apis/discovery.k8s.io/v1/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/v1/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/v1/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/v1/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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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/v1/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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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/v1/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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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/v1/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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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/v1/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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
    +
    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    Ingress
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    Ingress
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    Ingress
    +

    Response

    + + + + + + +
    CodeDescription
    200
    Ingress
    OK
    201
    Ingress
    Created
    +

    IngressClass v1 networking.k8s.io

    + + + + + +
    GroupVersionKind
    networking.k8s.iov1IngressClass
    + + + + + + + + + +
    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    IngressClass
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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. If the caller requests specific NodePorts (by specifying a value), those requests will be respected, regardless of this field. This field 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 beta-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. 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. Possible enum values: - `"Cluster"` specifies node-global (legacy) behavior. - `"Local"` specifies node-local endpoints behavior.
    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. 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. 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/create-external-load-balancer/
    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 Possible enum values: - `"ClientIP"` is the Client IP based. - `"None"` - no session affinity.
    sessionAffinityConfig
    SessionAffinityConfig
    sessionAffinityConfig contains the configurations of session affinity.
    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 Possible enum values: - `"ClusterIP"` means a service will only be accessible inside the cluster, via the cluster IP. - `"ExternalName"` means a service consists of only a reference to an external name that kubedns or equivalent will return as a CNAME record, with no exposing or proxying of any pods involved. - `"LoadBalancer"` means a service will be exposed via an external load balancer (if the cloud provider supports it), in addition to 'NodePort' type. - `"NodePort"` means a service will be exposed on one port of every node, in addition to 'ClusterIP' type.
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    Service
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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
    Service
    OK
    202
    Service
    Accepted
    +

    Delete Collection

    +

    delete collection of Service

    +

    HTTP Request

    +DELETE /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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not 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 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    Service
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    ConfigMap
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
    +
    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 immutable. Defaults to ReadWriteOnceWithFSType, which will examine each volume to determine if Kubernetes should modify ownership and permissions of the volume. With the default policy the defined fsGroup will only be applied if a fstype is defined and the volume's access mode contains ReadWriteOnce.
    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.
    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 was immutable in Kubernetes <= 1.22 and now is mutable. 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.
    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    CSIDriver
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
    +
    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    CSINode
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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. More info: https://kubernetes.io/docs/concepts/configuration/secret/#secret-types
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    Secret
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.
    dataSourceRef
    TypedLocalObjectReference
    Specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Alpha) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
    resources
    ResourceRequirements
    Resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. 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
    allocatedResources
    object
    The storage resource within AllocatedResources tracks the capacity allocated to a PVC. It may be larger than the actual capacity when a volume expansion operation is requested. For storage quota, the larger value from allocatedResources and PVC.spec.resources is used. If allocatedResources is not set, PVC.spec.resources alone is used for quota calculation. If a volume expansion capacity request is lowered, allocatedResources is only lowered if there are no expansion operations in progress and if the actual volume capacity is equal or lower than the requested capacity. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.
    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. Possible enum values: - `"Bound"` used for PersistentVolumeClaims that are bound - `"Lost"` used for PersistentVolumeClaims that lost their underlying PersistentVolume. The claim was bound to a PersistentVolume and this volume does not exist any longer and all data on it was lost. - `"Pending"` used for PersistentVolumeClaims that are not yet bound
    resizeStatus
    string
    ResizeStatus stores status of resize operation. ResizeStatus is not set by default but when expansion is complete resizeStatus is set to empty string by resize controller or kubelet. This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    PersistentVolumeClaim
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    PersistentVolumeClaim
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    PersistentVolumeClaim
    +

    Response

    + + + + + + +
    CodeDescription
    200
    PersistentVolumeClaim
    OK
    201
    PersistentVolumeClaim
    Created
    +

    StorageClass v1 storage.k8s.io

    + + + + + +
    GroupVersionKind
    storage.k8s.iov1StorageClass
    +
    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    StorageClass
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
    +

    CSIStorageCapacity v1beta1 storage.k8s.io

    + + + + + +
    GroupVersionKind
    storage.k8s.iov1beta1CSIStorageCapacity
    +
    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.
    +

    CSIStorageCapacityList 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
    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/v1beta1/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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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/v1beta1/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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    CSIStorageCapacity
    Created
    +

    Replace

    +

    replace the specified CSIStorageCapacity

    +

    HTTP Request

    +PUT /apis/storage.k8s.io/v1beta1/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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    CSIStorageCapacity
    +

    Response

    + + + + + + +
    CodeDescription
    200
    CSIStorageCapacity
    OK
    201
    CSIStorageCapacity
    Created
    +

    Delete

    +

    delete a CSIStorageCapacity

    +

    HTTP Request

    +DELETE /apis/storage.k8s.io/v1beta1/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/v1beta1/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/v1beta1/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/v1beta1/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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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/v1beta1/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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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/v1beta1/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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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/v1beta1/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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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/v1beta1/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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    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
    + + + + + + + + + + +
    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    VolumeAttachment
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    VolumeAttachment
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    ControllerRevision
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
    + + + + + + + + + + +
    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
    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
    Standard object's metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    CustomResourceDefinition
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    CustomResourceDefinition
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    CustomResourceDefinition
    +

    Response

    + + + + + + +
    CodeDescription
    200
    CustomResourceDefinition
    OK
    201
    CustomResourceDefinition
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    Event
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    LimitRange
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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: +v2 +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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    HorizontalPodAutoscaler
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    HorizontalPodAutoscaler
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    HorizontalPodAutoscaler
    +

    Response

    + + + + + + +
    CodeDescription
    200
    HorizontalPodAutoscaler
    OK
    201
    HorizontalPodAutoscaler
    Created
    +

    MutatingWebhookConfiguration v1 admissionregistration.k8s.io

    + + + + + +
    GroupVersionKind
    admissionregistration.k8s.iov1MutatingWebhookConfiguration
    + + + + + + + + + +
    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    MutatingWebhookConfiguration
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
    + + + + + + + + + +
    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    ValidatingWebhookConfiguration
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    PodTemplate
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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 v1 policy

    + + + + + +
    GroupVersionKind
    policyv1PodDisruptionBudget
    +
    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.
    +

    PodDisruptionBudgetSpec v1 policy

    +
    Appears In: + +
    + + + + + + + +
    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 will match no pods, while an empty ({}) selector will select all pods within the namespace.
    +

    PodDisruptionBudgetStatus v1 policy

    +
    Appears In: + +
    + + + + + + + + + + + +
    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 v1 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
    Items is a list of PodDisruptionBudgets
    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 a PodDisruptionBudget

    +

    HTTP Request

    +POST /apis/policy/v1/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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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/v1/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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    PodDisruptionBudget
    Created
    +

    Replace

    +

    replace the specified PodDisruptionBudget

    +

    HTTP Request

    +PUT /apis/policy/v1/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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    PodDisruptionBudget
    +

    Response

    + + + + + + +
    CodeDescription
    200
    PodDisruptionBudget
    OK
    201
    PodDisruptionBudget
    Created
    +

    Delete

    +

    delete a PodDisruptionBudget

    +

    HTTP Request

    +DELETE /apis/policy/v1/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/v1/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/v1/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/v1/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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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/v1/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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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/v1/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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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/v1/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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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/v1/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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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/v1/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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    PodDisruptionBudget
    Created
    +

    Read Status

    +

    read status of the specified PodDisruptionBudget

    +

    HTTP Request

    +GET /apis/policy/v1/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/v1/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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    PodDisruptionBudget
    +

    Response

    + + + + + + +
    CodeDescription
    200
    PodDisruptionBudget
    OK
    201
    PodDisruptionBudget
    Created
    +

    PriorityClass v1 scheduling.k8s.io

    + + + + + +
    GroupVersionKind
    scheduling.k8s.iov1PriorityClass
    + + + + + + + + + + + + +
    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    PriorityClass
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    PodSecurityPolicy
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
    + + + + + + + + + + +
    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
    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
    Items is the list of APIService
    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 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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    APIService
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    APIService
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    + + + + + + + + + + +
    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, expirationSeconds, 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
    expirationSeconds
    integer
    expirationSeconds is the requested duration of validity of the issued certificate. The certificate signer may issue a certificate with a different validity duration so a client must check the delta between the notBefore and and notAfter fields in the issued certificate to determine the actual duration. The v1.22+ in-tree implementations of the well-known Kubernetes signers will honor this field as long as the requested duration is not greater than the maximum duration they will honor per the --cluster-signing-duration CLI flag to the Kubernetes controller manager. Certificate signers may not honor this field for various reasons: 1. Old signer that is unaware of the field (such as the in-tree implementations prior to v1.22) 2. Signer whose configured maximum is shorter than the requested duration 3. Signer whose configured minimum is longer than the requested duration The minimum valid value for expirationSeconds is 600, i.e. 10 minutes. As of v1.22, this field is beta and is controlled via the CSRDuration feature gate.
    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    CertificateSigningRequest
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    CertificateSigningRequest
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    CertificateSigningRequest
    +

    Response

    + + + + + + +
    CodeDescription
    200
    CertificateSigningRequest
    OK
    201
    CertificateSigningRequest
    Created
    +

    ClusterRole v1 rbac.authorization.k8s.io

    + + + + + +
    GroupVersionKind
    rbac.authorization.k8s.iov1ClusterRole
    +
    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    ClusterRole
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
    + + + + + + + + + + +
    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    ClusterRoleBinding
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
    +
    Other API versions of this object exist: +v1beta2 +
    + + + + + + + + + + +
    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    FlowSchema
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    FlowSchema
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    FlowSchema
    +

    Response

    + + + + + + +
    CodeDescription
    200
    FlowSchema
    OK
    201
    FlowSchema
    Created
    +

    Lease v1 coordination.k8s.io

    + + + + + +
    GroupVersionKind
    coordination.k8s.iov1Lease
    +
    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    Lease
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
    + + + + + + + + + +
    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 list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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/ Possible enum values: - `"Active"` means the namespace is available for use in the system - `"Terminating"` means the namespace is undergoing graceful termination
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    Namespace
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    Namespace
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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
    Deprecated. If specified, the source of the node's configuration. The DynamicKubeletConfig feature gate must be enabled for the Kubelet to use this field. This field is deprecated as of 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration
    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. Possible enum values: - `"Pending"` means the node has been created/added by the system, but not configured. - `"Running"` means the node has been configured and has Kubernetes components running. - `"Terminated"` means the node has been removed from the cluster.
    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    Node
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    Node
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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 Possible enum values: - `"Delete"` means the volume will be deleted from Kubernetes on release from its claim. The volume plugin must support Deletion. - `"Recycle"` means the volume will be recycled back into the pool of unbound persistent volumes on release from its claim. The volume plugin must support Recycling. - `"Retain"` means the volume will be left in its current phase (Released) for manual reclamation by the administrator. The default policy is Retain.
    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 Possible enum values: - `"Available"` used for PersistentVolumes that are not yet bound Available volumes are held by the binder and matched to PersistentVolumeClaims - `"Bound"` used for PersistentVolumes that are bound - `"Failed"` used for PersistentVolumes that failed to be correctly recycled or deleted after being released from a claim - `"Pending"` used for PersistentVolumes that are not available - `"Released"` used for PersistentVolumes where the bound PersistentVolumeClaim was deleted released volumes must be recycled before becoming available again this phase is used by the persistent volume claim binder to signal to another process to reclaim the resource
    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    PersistentVolume
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    PersistentVolume
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    PersistentVolume
    +

    Response

    + + + + + + +
    CodeDescription
    200
    PersistentVolume
    OK
    201
    PersistentVolume
    Created
    +

    PriorityLevelConfiguration v1beta1 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta1PriorityLevelConfiguration
    +
    Other API versions of this object exist: +v1beta2 +
    + + + + + + + + + + +
    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    PriorityLevelConfiguration
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    PriorityLevelConfiguration
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    ResourceQuota
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    ResourceQuota
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    ResourceQuota
    +

    Response

    + + + + + + +
    CodeDescription
    200
    ResourceQuota
    OK
    201
    ResourceQuota
    Created
    +

    Role v1 rbac.authorization.k8s.io

    + + + + + +
    GroupVersionKind
    rbac.authorization.k8s.iov1Role
    +
    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    Role
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
    +
    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    RoleBinding
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    RuntimeClass
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
    + + + + + + + + + +
    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 list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    + + + + + + + + + +
    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 list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    ServiceAccount
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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
    Items holds a list of StorageVersion
    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 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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    StorageVersion
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    StorageVersion
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    StorageVersion
    +

    Response

    + + + + + + +
    CodeDescription
    200
    StorageVersion
    OK
    201
    StorageVersion
    Created
    +

    SubjectAccessReview v1 authorization.k8s.io

    + + + + + +
    GroupVersionKind
    authorization.k8s.iov1SubjectAccessReview
    + + + + + + + + + +
    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 list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    + + + + + + + + + +
    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
    TokenRequestSpec
    Spec holds information about the request being evaluated
    status
    TokenRequestStatus
    Status is filled in by the server and indicates whether the token can be authenticated.
    +

    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
    + + + + + + + + + +
    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
    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    NetworkPolicy
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

    + + + + + + + + + + +
    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

    +
    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

    +
    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.
    +

    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

    + + + + + + + + + + + +
    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. Possible enum values: - `"Approved"` Approved indicates the request was approved and should be issued by the signer. - `"Denied"` Denied indicates the request was denied and should not be issued by the signer. - `"Failed"` Failed indicates the signer failed to issue the certificate.
    +

    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. This API is deprecated since 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration

    +
    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". Possible enum values: - `"SCTP"` is the SCTP protocol. - `"TCP"` is the TCP protocol. - `"UDP"` is the UDP protocol.
    +

    ContainerResourceMetricSource v2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2ContainerResourceMetricSource
    +

    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: +v2beta2 +v2beta1 +
    +
    Appears In: + +
    + + + + + + + +
    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 v2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2ContainerResourceMetricStatus
    +

    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: +v2beta2 +v2beta1 +
    +
    Appears In: + +
    + + + + + + + +
    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.
    +

    CrossVersionObjectReference v1 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv1CrossVersionObjectReference
    +

    CrossVersionObjectReference contains enough information to let you identify the referred resource.

    +
    Other API versions of this object exist: +v2 +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.

    + + + + + + + + + + + +
    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.

    + + + + + + + +
    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.

    + + + + + + + + + + +
    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

    + + + + + + + + + + + +
    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.

    + + + + + + + + + + + + + +
    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.

    + + + + + + + + +
    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

    + + + + + +
    FieldDescription
    +

    CustomResourceSubresources v1 apiextensions.k8s.io

    + + + + + +
    GroupVersionKind
    apiextensions.k8s.iov1CustomResourceSubresources
    +

    CustomResourceSubresources defines the status and scale subresources for CustomResources.

    + + + + + + + +
    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.

    + + + + + + +
    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. Possible enum values: - `"OnDelete"` Replace the old daemons only when it's killed - `"RollingUpdate"` Replace the old daemons by new ones using rolling update i.e replace them on each node one after the other.
    +

    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.
    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. Possible enum values: - `"SCTP"` is the SCTP protocol. - `"TCP"` is the TCP protocol. - `"UDP"` is the UDP protocol.
    +

    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 previously 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. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(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 temporary container that you may add 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. The kubelet may evict a Pod if an ephemeral container causes the Pod to exceed its resource allocation. + +To add an ephemeral container, use the ephemeralcontainers subresource of an existing Pod. Ephemeral containers may not be removed or restarted. + +This is a beta feature available on clusters that haven't disabled the EphemeralContainers feature gate.

    +
    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. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(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. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(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 Possible enum values: - `"Always"` means that kubelet always attempts to pull the latest image. Container will fail If the pull fails. - `"IfNotPresent"` means that kubelet pulls if the image isn't present on disk. Container will fail if the image isn't present and the pull fails. - `"Never"` means that kubelet never pulls an image, but only uses a local image. Container will fail if the image isn't present
    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
    patch strategy: merge
    patch merge key: containerPort
    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
    Optional: SecurityContext defines the security options the ephemeral container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.
    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 uses the namespaces configured in the Pod spec. The container runtime must implement support for this feature. If the runtime does not support namespace targeting then the result of setting this field is undefined.
    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. Possible enum values: - `"FallbackToLogsOnError"` will read the most recent contents of the container logs for the container status message when the container exits with an error and the terminationMessagePath has no contents. - `"File"` is the default behavior and will set the container status message to the contents of the container's terminationMessagePath when the container exits.
    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. Subpath mounts are not allowed for ephemeral containers. 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.
    +

    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 events.k8s.io

    + + + + + +
    GroupVersionKind
    events.k8s.iov1EventSeries
    +

    EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time. How often to update the EventSeries is up to the event reporters. The default event reporter in "k8s.io/client-go/tools/events/event_broadcaster.go" shows how this struct is updated on heartbeats and can guide customized reporter implementations.

    +
    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.
    +

    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 v1 policy

    + + + + + +
    GroupVersionKind
    policyv1Eviction
    +

    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.

    + + + + + + +
    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.

    + + + + + + + +
    FieldDescription
    description
    string
    url
    string
    +

    ExternalMetricSource v2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2ExternalMetricSource
    +

    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: +v2beta2 +v2beta1 +
    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    metric
    MetricIdentifier
    metric identifies the target metric by name and selector
    target
    MetricTarget
    target specifies the target value for the given metric
    +

    ExternalMetricStatus v2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2ExternalMetricStatus
    +

    ExternalMetricStatus indicates the current value of a global metric not associated with any Kubernetes object.

    +
    Other API versions of this object exist: +v2beta2 +v2beta1 +
    +
    Appears In: + +
    + + + + + + +
    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 v1beta2 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta2FlowDistinguisherMethod
    +

    FlowDistinguisherMethod specifies the method of a flow distinguisher.

    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + +
    FieldDescription
    type
    string
    `type` is the type of flow distinguisher method The supported types are "ByUser" and "ByNamespace". Required.
    +

    FlowSchema v1beta2 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta2FlowSchema
    +

    FlowSchema defines the schema of a group of flows. Note that a flow is made up of a set of inbound API requests with similar attributes and is identified by a pair of strings: the name of the FlowSchema and a "flow distinguisher".

    +
    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
    `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
    +

    FlowSchemaCondition v1beta2 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta2FlowSchemaCondition
    +

    FlowSchemaCondition describes conditions for a FlowSchema.

    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + + + + +
    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
    +

    GRPCAction v1 core

    + + + + + +
    GroupVersionKind
    corev1GRPCAction
    +

    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    port
    integer
    Port number of the gRPC service. Number must be in the range 1 to 65535.
    service
    string
    Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.
    +

    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 v1beta2 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta2GroupSubject
    +

    GroupSubject holds detailed information for group-kind subject.

    +
    Other API versions of this object exist: +v1beta1 +
    +
    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 v2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2HPAScalingPolicy
    +

    HPAScalingPolicy is a single policy which must hold true for a specified past interval.

    +
    Other API versions of this object exist: +v2beta2 +
    + + + + + + + + +
    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 v2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2HPAScalingRules
    +

    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.

    +
    Other API versions of this object exist: +v2beta2 +
    + + + + + + + + +
    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 Max 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.

    + + + + + + + + + + +
    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. Possible enum values: - `"HTTP"` means that the scheme used will be http:// - `"HTTPS"` means that the scheme used will be https://
    +

    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.

    + + + + + + + + +
    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 '/' and must be present when using PathType with value "Exact" or "Prefix".
    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 '#'.

    +
    Appears In: + +
    + + + + + +
    FieldDescription
    paths
    HTTPIngressPath array
    A collection of paths that map requests to backends.
    +

    HorizontalPodAutoscaler v2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2HorizontalPodAutoscaler
    +

    HorizontalPodAutoscaler is the configuration for a horizontal pod autoscaler, which automatically manages the replica count of any resource implementing the scale subresource based on the metrics specified.

    +
    Other API versions of this object exist: +v1 +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
    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.
    +

    HorizontalPodAutoscalerBehavior v2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2HorizontalPodAutoscalerBehavior
    +

    HorizontalPodAutoscalerBehavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively).

    +
    Other API versions of this object exist: +v2beta2 +
    + + + + + + + +
    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 v2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2HorizontalPodAutoscalerCondition
    +

    HorizontalPodAutoscalerCondition describes the state of a HorizontalPodAutoscaler at a certain point.

    +
    Other API versions of this object exist: +v2beta2 +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.

    + + + + + + + +
    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.

    + + + + + + + + + + +
    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".
    +

    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.

    +
    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.

    +
    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.

    + + + + + +
    FieldDescription
    +

    JSONSchemaProps v1 apiextensions.k8s.io

    + + + + + +
    GroupVersionKind
    apiextensions.k8s.iov1JSONSchemaProps
    +

    JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/).

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    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.
    x-kubernetes-validations
    ValidationRule array
    patch strategy: merge
    patch merge key: rule
    x-kubernetes-validations describes a list of validation rules written in the CEL expression language. This field is an alpha-level. Using this field requires the feature gate `CustomResourceValidationExpressions` to be enabled.
    +

    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.

    + + + + + +
    FieldDescription
    +

    JSONSchemaPropsOrBool v1 apiextensions.k8s.io

    + + + + + +
    GroupVersionKind
    apiextensions.k8s.iov1JSONSchemaPropsOrBool
    +

    JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value. Defaults to true for the boolean property.

    + + + + + +
    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. Possible enum values: - `"Complete"` means the job has completed its execution. - `"Failed"` means the job has failed its execution. - `"Suspended"` means the job has been suspended.
    +

    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
    LifecycleHandler
    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
    LifecycleHandler
    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 Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). 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
    +

    LifecycleHandler v1 core

    + + + + + +
    GroupVersionKind
    corev1LifecycleHandler
    +

    LifecycleHandler defines a specific action that should be taken in a lifecycle hook. One and only one of the fields, except TCPSocket must be specified.

    +
    Appears In: + +
    + + + + + + + +
    FieldDescription
    exec
    ExecAction
    Exec specifies the action to take.
    httpGet
    HTTPGetAction
    HTTPGet specifies the http request to perform.
    tcpSocket
    TCPSocketAction
    Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.
    +

    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. Possible enum values: - `"Container"` Limit that applies to all containers in a namespace - `"PersistentVolumeClaim"` Limit that applies to all persistent volume claims in a namespace - `"Pod"` Limit that applies to all pods in a namespace
    +

    LimitResponse v1beta2 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta2LimitResponse
    +

    LimitResponse defines how to handle requests that can not be executed right now.

    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + +
    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 v1beta2 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta2LimitedPriorityLevelConfiguration
    +

    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?

    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + +
    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 filesystem 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'.
    subresource
    string
    Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
    time
    Time
    Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'
    +

    MetricIdentifier v2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2MetricIdentifier
    +

    MetricIdentifier defines the name and optionally selector for a metric

    +
    Other API versions of this object exist: +v2beta2 +
    + + + + + + + +
    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 v2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2MetricSpec
    +

    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: +v2beta2 +v2beta1 +
    + + + + + + + + + + + +
    FieldDescription
    containerResource
    ContainerResourceMetricSource
    containerResource 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 v2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2MetricStatus
    +

    MetricStatus describes the last-read state of a single metric.

    +
    Other API versions of this object exist: +v2beta2 +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 v2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2MetricTarget
    +

    MetricTarget defines the target value, average value, or average utilization of a specific metric

    +
    Other API versions of this object exist: +v2beta2 +
    + + + + + + + + + +
    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 v2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2MetricValueStatus
    +

    MetricValueStatus holds the current value for a metric

    +
    Other API versions of this object exist: +v2beta2 +
    + + + + + + + + +
    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.

    + + + + + + + + + + + + + + + + +
    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. Possible enum values: - `"NamespaceContentRemaining"` contains information about resources remaining in a namespace. - `"NamespaceDeletionContentFailure"` contains information about namespace deleter errors during deletion of resources. - `"NamespaceDeletionDiscoveryFailure"` contains information about namespace deleter errors during resource discovery. - `"NamespaceDeletionGroupVersionParsingFailure"` contains information about namespace deleter errors parsing GV for legacy types. - `"NamespaceFinalizersRemaining"` contains information about which finalizers are on resources remaining in a namespace.
    +

    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 Beta state and is enabled by default. It can be disabled 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. Possible enum values: - `"ExternalDNS"` identifies a DNS name which resolves to an IP address which has the characteristics of a NodeExternalIP. The IP it resolves to may or may not be a listed NodeExternalIP address. - `"ExternalIP"` identifies an IP address which is, in some way, intended to be more usable from outside the cluster then an internal IP, though no specific semantics are defined. It may be a globally routable IP, though it is not required to be. External IPs may be assigned directly to an interface on the node, like a NodeInternalIP, or alternatively, packets sent to the external IP may be NAT'ed to an internal node IP rather than being delivered directly (making the IP less efficient for node-to-node traffic than a NodeInternalIP). - `"Hostname"` identifies a name of the node. Although every node can be assumed to have a NodeAddress of this type, its exact syntax and semantics are not defined, and are not consistent between different clusters. - `"InternalDNS"` identifies a DNS name which resolves to an IP address which has the characteristics of a NodeInternalIP. The IP it resolves to may or may not be a listed NodeInternalIP address. - `"InternalIP"` identifies an IP address which is assigned to one of the node's network interfaces. Every node should have at least one address of this type. An internal IP is normally expected to be reachable from every other node, but may not be visible to hosts outside the cluster. By default it is assumed that kube-apiserver can reach node internal IPs, though it is possible to configure clusters where this is not the case. NodeInternalIP is the default type of node IP, and does not necessarily imply that the IP is ONLY reachable internally. If a node has multiple internal IPs, no specific semantics are assigned to the additional IPs.
    +

    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. Possible enum values: - `"DiskPressure"` means the kubelet is under pressure due to insufficient available disk. - `"MemoryPressure"` means the kubelet is under pressure due to insufficient available memory. - `"NetworkUnavailable"` means that network for the node is not correctly configured. - `"PIDPressure"` means the kubelet is under pressure due to insufficient available PID. - `"Ready"` means kubelet is healthy and ready to accept pods.
    +

    NodeConfigSource v1 core

    + + + + + +
    GroupVersionKind
    corev1NodeConfigSource
    +

    NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22

    + + + + + + +
    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. Possible enum values: - `"DoesNotExist"` - `"Exists"` - `"Gt"` - `"In"` - `"Lt"` - `"NotIn"`
    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

    + + + + + + + +
    FieldDescription
    path
    string
    Path is the URL path of the request
    verb
    string
    Verb is the standard HTTP verb
    +

    NonResourcePolicyRule v1beta2 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta2NonResourcePolicyRule
    +

    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.

    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + +
    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

    + + + + + + + +
    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 v2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2ObjectMetricSource
    +

    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: +v2beta2 +v2beta1 +
    +
    Appears In: + +
    + + + + + + + +
    FieldDescription
    describedObject
    CrossVersionObjectReference
    describedObject specifies the descriptions of a object,such as kind,name apiVersion
    metric
    MetricIdentifier
    metric identifies the target metric by name and selector
    target
    MetricTarget
    target specifies the target value for the given metric
    +

    ObjectMetricStatus v2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2ObjectMetricStatus
    +

    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: +v2beta2 +v2beta1 +
    +
    Appears In: + +
    + + + + + + + +
    FieldDescription
    current
    MetricValueStatus
    current contains the current value for the given metric
    describedObject
    CrossVersionObjectReference
    DescribedObject specifies the descriptions of a object,such as kind,name apiVersion
    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
    Possible enum values: - `"FileSystemResizePending"` - controller resize is finished and a file system resize is pending on node - `"Resizing"` - a user trigger resize of pvc has been started
    +

    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 beta-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 Possible enum values: - `"ContainersReady"` indicates whether all containers in the pod are ready. - `"Initialized"` means that all init containers in the pod have started successfully. - `"PodScheduled"` represents status of the scheduling process for this pod. - `"Ready"` means the pod is able to service requests and should be added to the load balancing pools of all matching services.
    +

    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
    +

    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
    +

    PodOS v1 core

    + + + + + +
    GroupVersionKind
    corev1PodOS
    +

    PodOS defines the OS parameters of a pod.

    +
    Appears In: + +
    + + + + + +
    FieldDescription
    name
    string
    Name is the name of the operating system. The currently supported values are linux and windows. Additional value may be defined in future and can be one of: https://github.com/opencontainers/runtime-spec/blob/master/config.md#platform-specific-configuration Clients should expect to handle additional values and treat unrecognized values in this field as os: null
    +

    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. Possible enum values: - `"ContainersReady"` indicates whether all containers in the pod are ready. - `"Initialized"` means that all init containers in the pod have started successfully. - `"PodScheduled"` represents status of the scheduling process for this pod. - `"Ready"` means the pod is able to service requests and should be added to the load balancing pools of all matching services.
    +

    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. Note that this field cannot be set when spec.os.name is windows.
    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. Note that this field cannot be set when spec.os.name is windows.
    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. Note that this field cannot be set when spec.os.name is windows.
    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. Note that this field cannot be set when spec.os.name is windows.
    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. Note that this field cannot be set when spec.os.name is windows.
    seccompProfile
    SeccompProfile
    The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.
    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. Note that this field cannot be set when spec.os.name is windows.
    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. Note that this field cannot be set when spec.os.name is windows.
    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. Note that this field cannot be set when spec.os.name is linux.
    +

    PodsMetricSource v2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2PodsMetricSource
    +

    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: +v2beta2 +v2beta1 +
    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    metric
    MetricIdentifier
    metric identifies the target metric by name and selector
    target
    MetricTarget
    target specifies the target value for the given metric
    +

    PodsMetricStatus v2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2PodsMetricStatus
    +

    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: +v2beta2 +v2beta1 +
    +
    Appears In: + +
    + + + + + + +
    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.

    +
    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. '\*' represents all resources.
    verbs
    string array
    Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '\*' represents all verbs.
    +

    PolicyRulesWithSubjects v1beta2 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta2PolicyRulesWithSubjects
    +

    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.

    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + + +
    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" Possible enum values: - `"SCTP"` is the SCTP protocol. - `"TCP"` is the TCP protocol. - `"UDP"` is the UDP protocol.
    +

    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.
    +

    PriorityLevelConfiguration v1beta2 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta2PriorityLevelConfiguration
    +

    PriorityLevelConfiguration represents the configuration of a priority level.

    +
    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
    `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
    +

    PriorityLevelConfigurationCondition v1beta2 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta2PriorityLevelConfigurationCondition
    +

    PriorityLevelConfigurationCondition defines the condition of priority level.

    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + + + + +
    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 v1beta2 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta2PriorityLevelConfigurationReference
    +

    PriorityLevelConfigurationReference contains information that points to the "request-priority" being used.

    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + +
    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
    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.
    grpc
    GRPCAction
    GRPC specifies an action involving a GRPC port. This is an alpha field and requires enabling GRPCContainerProbe feature gate.
    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.
    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 a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
    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 v1beta2 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta2QueuingConfiguration
    +

    QueuingConfiguration holds the configuration parameters for queuing

    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + + +
    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

    + + + + + + + + + + + + +
    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 v2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2ResourceMetricSource
    +

    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: +v2beta2 +v2beta1 +
    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    name
    string
    name is the name of the resource in question.
    target
    MetricTarget
    target specifies the target value for the given metric
    +

    ResourceMetricStatus v2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2ResourceMetricStatus
    +

    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: +v2beta2 +v2beta1 +
    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    current
    MetricValueStatus
    current contains the current value for the given metric
    name
    string
    Name is the name of the resource in question.
    +

    ResourcePolicyRule v1beta2 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta2ResourcePolicyRule
    +

    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) either (d1) the request does not specify a namespace (i.e., `Namespace==""`) and clusterScope is true or (d2) the request specifies a namespace and least one member of namespaces matches the request's namespace.

    +
    Other API versions of this object exist: +v1beta1 +
    + + + + + + + + + + +
    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.

    + + + + + + + + + +
    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

    + + + + + + + + +
    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.

    + + + + + + + + + + +
    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. Possible enum values: - `"DoesNotExist"` - `"Exists"` - `"In"` - `"NotIn"`
    scopeName
    string
    The name of the scope that the selector applies to. Possible enum values: - `"BestEffort"` Match all pod objects that have best effort quality of service - `"CrossNamespacePodAffinity"` Match all pod objects that have cross-namespace pod (anti)affinity mentioned. This is a beta feature enabled by the PodAffinityNamespaceSelector feature flag. - `"NotBestEffort"` Match all pod objects that do not have best effort quality of service - `"NotTerminating"` Match all pod objects where spec.activeDeadlineSeconds is nil - `"PriorityClass"` Match all pod objects that have priority class mentioned - `"Terminating"` Match all pod objects where spec.activeDeadlineSeconds >=0
    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. Possible enum values: - `"Localhost"` indicates a profile defined in a file on the node should be used. The file's location relative to <kubelet-root-dir>/seccomp. - `"RuntimeDefault"` represents the default container runtime seccomp profile. - `"Unconfined"` indicates no seccomp profile is applied (A.K.A. unconfined).
    +

    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 Note that this field cannot be set when spec.os.name is windows.
    capabilities
    Capabilities
    The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.
    privileged
    boolean
    Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.
    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. Note that this field cannot be set when spec.os.name is windows.
    readOnlyRootFilesystem
    boolean
    Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.
    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. Note that this field cannot be set when spec.os.name is windows.
    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. Note that this field cannot be set when spec.os.name is windows.
    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. Note that this field cannot be set when spec.os.name is windows.
    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. Note that this field cannot be set when spec.os.name is windows.
    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. Note that this field cannot be set when spec.os.name is linux.
    +

    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 v1beta2 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta2ServiceAccountSubject
    +

    ServiceAccountSubject holds detailed information for service-account-kind subject.

    +
    Other API versions of this object exist: +v1beta1 +
    +
    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.
    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. Possible enum values: - `"SCTP"` is the SCTP protocol. - `"TCP"` is the TCP protocol. - `"UDP"` is the UDP protocol.
    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

    + + + + + + + + + +
    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.
    +

    StatefulSetPersistentVolumeClaimRetentionPolicy v1 apps

    + + + + + +
    GroupVersionKind
    appsv1StatefulSetPersistentVolumeClaimRetentionPolicy
    +

    StatefulSetPersistentVolumeClaimRetentionPolicy describes the policy used for PVCs created from the StatefulSet VolumeClaimTemplates.

    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    whenDeleted
    string
    WhenDeleted specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is deleted. The default policy of `Retain` causes PVCs to not be affected by StatefulSet deletion. The `Delete` policy causes those PVCs to be deleted.
    whenScaled
    string
    WhenScaled specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is scaled down. The default policy of `Retain` causes PVCs to not be affected by a scaledown. The `Delete` policy causes the associated PVCs for any excess pods above the replica count to be deleted.
    +

    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. Possible enum values: - `"OnDelete"` triggers the legacy behavior. Version tracking and ordered rolling restarts are disabled. Pods are recreated from the StatefulSetSpec when they are manually deleted. When a scale operation is performed with this strategy,specification version indicated by the StatefulSet's currentRevision. - `"RollingUpdate"` indicates that update will be applied to all Pods in the StatefulSet with respect to the StatefulSet ordering constraints. When a scale operation is performed with this strategy, new Pods will be created from the specification version indicated by the StatefulSet's updateRevision.
    +

    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 v1beta2 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta2Subject
    +

    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: +v1beta1 +v1 +
    + + + + + + + + + +
    FieldDescription
    group
    GroupSubject
    `group` matches based on user group name.
    kind
    string
    `kind` indicates which one of the other fields is non-empty. Required
    serviceAccount
    ServiceAccountSubject
    `serviceAccount` matches ServiceAccounts.
    user
    UserSubject
    `user` matches based on username.
    +

    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.

    + + + + + + + + + +
    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

    + + + + + + + +
    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. Possible enum values: - `"NoExecute"` Evict any already-running pods that do not tolerate the taint. Currently enforced by NodeController. - `"NoSchedule"` Do not allow new pods to schedule onto the node unless they tolerate the taint, but allow all pods submitted to Kubelet without going through the scheduler to start, and allow all already-running pods to continue running. Enforced by the scheduler. - `"PreferNoSchedule"` Like TaintEffectNoSchedule, but the scheduler tries not to schedule new pods onto the node, rather than prohibiting new pods from scheduling onto the node entirely. Enforced by the scheduler.
    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. Possible enum values: - `"NoExecute"` Evict any already-running pods that do not tolerate the taint. Currently enforced by NodeController. - `"NoSchedule"` Do not allow new pods to schedule onto the node unless they tolerate the taint, but allow all pods submitted to Kubelet without going through the scheduler to start, and allow all already-running pods to continue running. Enforced by the scheduler. - `"PreferNoSchedule"` Like TaintEffectNoSchedule, but the scheduler tries not to schedule new pods onto the node, rather than prohibiting new pods from scheduling onto the node entirely. Enforced by the scheduler.
    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. Possible enum values: - `"Equal"` - `"Exists"`
    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.

    +
    Appears In: + +
    + + + + + +
    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 assignment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field. Possible enum values: - `"DoNotSchedule"` instructs the scheduler not to schedule the pod when constraints are not satisfied. - `"ScheduleAnyway"` instructs the scheduler to schedule the pod even if constraints are not satisfied.
    +

    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
    +

    UncountedTerminatedPods v1 batch

    + + + + + +
    GroupVersionKind
    batchv1UncountedTerminatedPods
    +

    UncountedTerminatedPods holds UIDs of Pods that have terminated but haven't been accounted in Job status counters.

    +
    Appears In: + +
    + + + + + + +
    FieldDescription
    failed
    string array
    Failed holds UIDs of failed Pods.
    succeeded
    string array
    Succeeded holds UIDs of succeeded Pods.
    +

    UserInfo v1 authentication.k8s.io

    + + + + + +
    GroupVersionKind
    authentication.k8s.iov1UserInfo
    +

    UserInfo holds the information about the user needed to implement the user.Info interface.

    + + + + + + + + + +
    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 v1beta2 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta2UserSubject
    +

    UserSubject holds detailed information for user-kind subject.

    +
    Other API versions of this object exist: +v1beta1 +
    +
    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.

    + + + + + + + + + + + + + + + +
    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.
    +

    ValidationRule v1 apiextensions.k8s.io

    + + + + + +
    GroupVersionKind
    apiextensions.k8s.iov1ValidationRule
    +

    ValidationRule describes a validation rule written in the CEL expression language.

    + + + + + + + +
    FieldDescription
    message
    string
    Message represents the message displayed when validation fails. The message is required if the Rule contains line breaks. The message must not contain line breaks. If unset, the message is "failed rule: {Rule}". e.g. "must be a URL with the host matching spec.host"
    rule
    string
    Rule represents the expression which will be evaluated by CEL. ref: https://github.com/google/cel-spec The Rule is scoped to the location of the x-kubernetes-validations extension in the schema. The `self` variable in the CEL expression is bound to the scoped value. Example: - Rule scoped to the root of a resource with a status subresource: {"rule": "self.status.actual <= self.spec.maxDesired"} If the Rule is scoped to an object with properties, the accessible properties of the object are field selectable via `self.field` and field presence can be checked via `has(self.field)`. Null valued fields are treated as absent fields in CEL expressions. If the Rule is scoped to an object with additionalProperties (i.e. a map) the value of the map are accessible via `self[mapKey]`, map containment can be checked via `mapKey in self` and all entries of the map are accessible via CEL macros and functions such as `self.all(...)`. If the Rule is scoped to an array, the elements of the array are accessible via `self[i]` and also by macros and functions. If the Rule is scoped to a scalar, `self` is bound to the scalar value. Examples: - Rule scoped to a map of objects: {"rule": "self.components['Widget'].priority < 10"} - Rule scoped to a list of integers: {"rule": "self.values.all(value, value >= 0 && value < 100)"} - Rule scoped to a string value: {"rule": "self.startsWith('kube')"} The `apiVersion`, `kind`, `metadata.name` and `metadata.generateName` are always accessible from the root of the object and from any x-kubernetes-embedded-resource annotated objects. No other metadata properties are accessible. Unknown data preserved in custom resources via x-kubernetes-preserve-unknown-fields is not accessible in CEL expressions. This includes: - Unknown field values that are preserved by object schemas with x-kubernetes-preserve-unknown-fields. - Object properties where the property schema is of an "unknown type". An "unknown type" is recursively defined as: - A schema with no type and x-kubernetes-preserve-unknown-fields set to true - An array where the items schema is of an "unknown type" - An object where the additionalProperties schema is of an "unknown type" Only property names of the form `[a-zA-Z_.-/][a-zA-Z0-9_.-/]*` are accessible. Accessible property names are escaped according to the following rules when accessed in the expression: - '__' escapes to '__underscores__' - '.' escapes to '__dot__' - '-' escapes to '__dash__' - '/' escapes to '__slash__' - Property names that exactly match a CEL RESERVED keyword escape to '__{keyword}__'. The keywords are: "true", "false", "null", "in", "as", "break", "const", "continue", "else", "for", "function", "if", "import", "let", "loop", "package", "namespace", "return". Examples: - Rule accessing a property named "namespace": {"rule": "self.__namespace__ > 0"} - Rule accessing a property named "x-prop": {"rule": "self.x__dash__prop > 0"} - Rule accessing a property named "redact__d": {"rule": "self.redact__underscores__d > 0"} Equality on arrays with x-kubernetes-list-type of 'set' or 'map' ignores element order, i.e. [1, 2] == [2, 1]. Concatenation on arrays with x-kubernetes-list-type use the semantics of the list type: - 'set': `X + Y` performs a union where the array positions of all elements in `X` are preserved and non-intersecting elements in `Y` are appended, retaining their partial order. - 'map': `X + Y` performs a merge where the array positions of all keys in `X` are preserved but the values are overwritten by values in `Y` when the key sets of `X` and `Y` intersect. Elements in `Y` with non-intersecting keys are appended, retaining their partial order.
    +

    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.

    + + + + + + + +
    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.

    + + + + + + + +
    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.

    +
    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

    + + + + + + + + +
    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.
    hostProcess
    boolean
    HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.
    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.

    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    CSIStorageCapacity
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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 v2beta2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta2ContainerResourceMetricSource
    +
    Other API versions of this object exist: +v2 +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
    +

    ContainerResourceMetricSource v2beta1 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta1ContainerResourceMetricSource
    +
    Other API versions of this object exist: +v2 +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 v2beta2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta2ContainerResourceMetricStatus
    +
    Other API versions of this object exist: +v2 +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.
    +

    ContainerResourceMetricStatus v2beta1 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta1ContainerResourceMetricStatus
    +
    Other API versions of this object exist: +v2 +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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    CronJob
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    CronJob
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    CronJob
    +

    Response

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

    CrossVersionObjectReference v2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2CrossVersionObjectReference
    +
    Other API versions of this object exist: +v1 +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
    +

    CrossVersionObjectReference v2beta2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta2CrossVersionObjectReference
    +
    Other API versions of this object exist: +v1 +v2 +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 +v2 +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
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    EndpointSlice
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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 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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    Event
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    Event
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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 core

    + + + + + +
    GroupVersionKind
    corev1EventSeries
    +
    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
    +

    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.
    +

    ExternalMetricSource v2beta2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta2ExternalMetricSource
    +
    Other API versions of this object exist: +v2 +v2beta1 +
    + + + + + + + +
    FieldDescription
    metric
    MetricIdentifier
    metric identifies the target metric by name and selector
    target
    MetricTarget
    target specifies the target value for the given metric
    +

    ExternalMetricSource v2beta1 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta1ExternalMetricSource
    +
    Other API versions of this object exist: +v2 +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 v2beta2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta2ExternalMetricStatus
    +
    Other API versions of this object exist: +v2 +v2beta1 +
    + + + + + + + +
    FieldDescription
    current
    MetricValueStatus
    current contains the current value for the given metric
    metric
    MetricIdentifier
    metric identifies the target metric by name and selector
    +

    ExternalMetricStatus v2beta1 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta1ExternalMetricStatus
    +
    Other API versions of this object exist: +v2 +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.
    +

    FlowDistinguisherMethod v1beta1 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta1FlowDistinguisherMethod
    +
    Other API versions of this object exist: +v1beta2 +
    + + + + + + +
    FieldDescription
    type
    string
    `type` is the type of flow distinguisher method The supported types are "ByUser" and "ByNamespace". Required.
    +

    FlowSchema v1beta1 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta1FlowSchema
    +
    Other API versions of this object exist: +v1beta2 +
    + + + + + + + + + + +
    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    FlowSchema
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    FlowSchema
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    FlowSchema
    +

    Response

    + + + + + + +
    CodeDescription
    200
    FlowSchema
    OK
    201
    FlowSchema
    Created
    +

    FlowSchemaCondition v1beta1 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta1FlowSchemaCondition
    +
    Other API versions of this object exist: +v1beta2 +
    + + + + + + + + + + +
    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 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.
    +

    GroupSubject v1beta1 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta1GroupSubject
    +
    Other API versions of this object exist: +v1beta2 +
    +
    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.
    +

    HPAScalingPolicy v2beta2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta2HPAScalingPolicy
    +
    Other API versions of this object exist: +v2 +
    + + + + + + + + +
    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
    +
    Other API versions of this object exist: +v2 +
    + + + + + + + + +
    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).
    +

    HorizontalPodAutoscaler v1 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv1HorizontalPodAutoscaler
    +
    Other API versions of this object exist: +v2 +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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    HorizontalPodAutoscaler
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    HorizontalPodAutoscaler
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    HorizontalPodAutoscaler
    +

    Response

    + + + + + + +
    CodeDescription
    200
    HorizontalPodAutoscaler
    OK
    201
    HorizontalPodAutoscaler
    Created
    +

    HorizontalPodAutoscaler v2beta2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta2HorizontalPodAutoscaler
    +
    Other API versions of this object exist: +v2 +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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    HorizontalPodAutoscaler
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    HorizontalPodAutoscaler
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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: +v2 +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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    HorizontalPodAutoscaler
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    HorizontalPodAutoscaler
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    HorizontalPodAutoscaler
    +

    Response

    + + + + + + +
    CodeDescription
    200
    HorizontalPodAutoscaler
    OK
    201
    HorizontalPodAutoscaler
    Created
    +

    HorizontalPodAutoscalerBehavior v2beta2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta2HorizontalPodAutoscalerBehavior
    +
    Other API versions of this object exist: +v2 +
    + + + + + + + +
    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
    +
    Other API versions of this object exist: +v2 +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
    +

    HorizontalPodAutoscalerCondition v2beta1 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta1HorizontalPodAutoscalerCondition
    +
    Other API versions of this object exist: +v2 +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
    +

    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
    +

    LimitResponse v1beta1 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta1LimitResponse
    +
    Other API versions of this object exist: +v1beta2 +
    + + + + + + + +
    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
    +
    Other API versions of this object exist: +v1beta2 +
    + + + + + + + +
    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
    +

    MetricIdentifier v2beta2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta2MetricIdentifier
    +
    Other API versions of this object exist: +v2 +
    + + + + + + + +
    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
    +
    Other API versions of this object exist: +v2 +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
    +

    MetricSpec v2beta1 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta1MetricSpec
    +
    Other API versions of this object exist: +v2 +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 v2beta2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta2MetricStatus
    +
    Other API versions of this object exist: +v2 +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
    +

    MetricStatus v2beta1 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta1MetricStatus
    +
    Other API versions of this object exist: +v2 +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
    +

    MetricTarget v2beta2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta2MetricTarget
    +
    Other API versions of this object exist: +v2 +
    + + + + + + + + + +
    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
    +
    Other API versions of this object exist: +v2 +
    + + + + + + + + +
    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).
    +

    NonResourcePolicyRule v1beta1 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta1NonResourcePolicyRule
    +
    Other API versions of this object exist: +v1beta2 +
    + + + + + + + +
    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.
    +

    ObjectMetricSource v2beta2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta2ObjectMetricSource
    +
    Other API versions of this object exist: +v2 +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
    +

    ObjectMetricSource v2beta1 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta1ObjectMetricSource
    +
    Other API versions of this object exist: +v2 +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 v2beta2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta2ObjectMetricStatus
    +
    Other API versions of this object exist: +v2 +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
    +

    ObjectMetricStatus v2beta1 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta1ObjectMetricStatus
    +
    Other API versions of this object exist: +v2 +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
    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.
    +

    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
    items list individual PodDisruptionBudget 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 object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    PodDisruptionBudget
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    PodDisruptionBudget
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    PodDisruptionBudget
    +

    Response

    + + + + + + +
    CodeDescription
    200
    PodDisruptionBudget
    OK
    201
    PodDisruptionBudget
    Created
    +

    PodsMetricSource v2beta2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta2PodsMetricSource
    +
    Other API versions of this object exist: +v2 +v2beta1 +
    + + + + + + + +
    FieldDescription
    metric
    MetricIdentifier
    metric identifies the target metric by name and selector
    target
    MetricTarget
    target specifies the target value for the given metric
    +

    PodsMetricSource v2beta1 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta1PodsMetricSource
    +
    Other API versions of this object exist: +v2 +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 v2beta2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta2PodsMetricStatus
    +
    Other API versions of this object exist: +v2 +v2beta1 +
    + + + + + + + +
    FieldDescription
    current
    MetricValueStatus
    current contains the current value for the given metric
    metric
    MetricIdentifier
    metric identifies the target metric by name and selector
    +

    PodsMetricStatus v2beta1 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta1PodsMetricStatus
    +
    Other API versions of this object exist: +v2 +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.
    +

    PolicyRulesWithSubjects v1beta1 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta1PolicyRulesWithSubjects
    +
    Other API versions of this object exist: +v1beta2 +
    + + + + + + + + +
    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.
    +

    PriorityLevelConfiguration v1beta1 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta1PriorityLevelConfiguration
    +
    Other API versions of this object exist: +v1beta2 +
    + + + + + + + + + + +
    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    PriorityLevelConfiguration
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    PriorityLevelConfiguration
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    Body Parameters

    + + + + + +
    ParameterDescription
    body
    PriorityLevelConfiguration
    +

    Response

    + + + + + + +
    CodeDescription
    200
    PriorityLevelConfiguration
    OK
    201
    PriorityLevelConfiguration
    Created
    +

    PriorityLevelConfigurationCondition v1beta1 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta1PriorityLevelConfigurationCondition
    +
    Other API versions of this object exist: +v1beta2 +
    + + + + + + + + + + +
    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
    +
    Other API versions of this object exist: +v1beta2 +
    + + + + + + +
    FieldDescription
    name
    string
    `name` is the name of the priority level configuration being referenced Required.
    +

    QueuingConfiguration v1beta1 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta1QueuingConfiguration
    +
    Other API versions of this object exist: +v1beta2 +
    + + + + + + + + +
    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.
    +

    ResourceMetricSource v2beta2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta2ResourceMetricSource
    +
    Other API versions of this object exist: +v2 +v2beta1 +
    + + + + + + + +
    FieldDescription
    name
    string
    name is the name of the resource in question.
    target
    MetricTarget
    target specifies the target value for the given metric
    +

    ResourceMetricSource v2beta1 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta1ResourceMetricSource
    +
    Other API versions of this object exist: +v2 +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 v2beta2 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta2ResourceMetricStatus
    +
    Other API versions of this object exist: +v2 +v2beta1 +
    + + + + + + + +
    FieldDescription
    current
    MetricValueStatus
    current contains the current value for the given metric
    name
    string
    Name is the name of the resource in question.
    +

    ResourceMetricStatus v2beta1 autoscaling

    + + + + + +
    GroupVersionKind
    autoscalingv2beta1ResourceMetricStatus
    +
    Other API versions of this object exist: +v2 +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.
    +

    ResourcePolicyRule v1beta1 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta1ResourcePolicyRule
    +
    Other API versions of this object exist: +v1beta2 +
    + + + + + + + + + + +
    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.
    +

    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/688-pod-overhead/README.md This field is beta-level as of Kubernetes 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 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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    RuntimeClass
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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/688-pod-overhead/README.md This field is beta-level as of Kubernetes v1.18, 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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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).
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    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
    201
    RuntimeClass
    Created
    +

    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.
    fieldValidationfieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields.
    +

    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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
    fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
    labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
    limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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.
    +

    ServiceAccountSubject v1beta1 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta1ServiceAccountSubject
    +
    Other API versions of this object exist: +v1beta2 +
    +
    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.
    +

    ServiceReference v1 apiextensions.k8s.io

    + + + + + +
    GroupVersionKind
    apiextensions.k8s.iov1ServiceReference
    + + + + + + + + + +
    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
    + + + + + + + + +
    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).
    +

    Subject v1 rbac.authorization.k8s.io

    + + + + + +
    GroupVersionKind
    rbac.authorization.k8s.iov1Subject
    +
    Other API versions of this object exist: +v1beta2 +v1beta1 +
    + + + + + + + + + +
    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 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta1Subject
    +
    Other API versions of this object exist: +v1beta2 +v1 +
    + + + + + + + + + +
    FieldDescription
    group
    GroupSubject
    `group` matches based on user group name.
    kind
    string
    `kind` indicates which one of the other fields is non-empty. Required
    serviceAccount
    ServiceAccountSubject
    `serviceAccount` matches ServiceAccounts.
    user
    UserSubject
    `user` matches based on username.
    +

    TokenRequest v1 storage.k8s.io

    + + + + + +
    GroupVersionKind
    storage.k8s.iov1TokenRequest
    +
    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".
    +

    UserSubject v1beta1 flowcontrol.apiserver.k8s.io

    + + + + + +
    GroupVersionKind
    flowcontrol.apiserver.k8s.iov1beta1UserSubject
    +
    Other API versions of this object exist: +v1beta2 +
    +
    Appears In: + +
    + + + + + +
    FieldDescription
    name
    string
    `name` is the username that matches, or "*" to match all usernames. Required.
    +

    WebhookClientConfig v1 apiextensions.k8s.io

    + + + + + +
    GroupVersionKind
    apiextensions.k8s.iov1WebhookClientConfig
    + + + + + + + + +
    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.23/js/navData.js b/static/docs/reference/generated/kubernetes-api/v1.23/js/navData.js new file mode 100644 index 0000000000000..3f54c376ef5ad --- /dev/null +++ b/static/docs/reference/generated/kubernetes-api/v1.23/js/navData.js @@ -0,0 +1 @@ +(function(){navData={"toc":[{"section":"webhookclientconfig-v1-apiextensions-k8s-io","subsections":[]},{"section":"usersubject-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"tokenrequest-v1-storage-k8s-io","subsections":[]},{"section":"subject-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"subject-v1-rbac-authorization-k8s-io","subsections":[]},{"section":"servicereference-v1-apiregistration-k8s-io","subsections":[]},{"section":"servicereference-v1-apiextensions-k8s-io","subsections":[]},{"section":"serviceaccountsubject-v1beta1-flowcontrol-apiserver-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":"resourcepolicyrule-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"resourcemetricstatus-v2beta1-autoscaling","subsections":[]},{"section":"resourcemetricstatus-v2beta2-autoscaling","subsections":[]},{"section":"resourcemetricsource-v2beta1-autoscaling","subsections":[]},{"section":"resourcemetricsource-v2beta2-autoscaling","subsections":[]},{"section":"queuingconfiguration-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"prioritylevelconfigurationreference-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"prioritylevelconfigurationcondition-v1beta1-flowcontrol-apiserver-k8s-io","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":"policyruleswithsubjects-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"podsmetricstatus-v2beta1-autoscaling","subsections":[]},{"section":"podsmetricstatus-v2beta2-autoscaling","subsections":[]},{"section":"podsmetricsource-v2beta1-autoscaling","subsections":[]},{"section":"podsmetricsource-v2beta2-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":"objectmetricstatus-v2beta2-autoscaling","subsections":[]},{"section":"objectmetricsource-v2beta1-autoscaling","subsections":[]},{"section":"objectmetricsource-v2beta2-autoscaling","subsections":[]},{"section":"nonresourcepolicyrule-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"metricvaluestatus-v2beta2-autoscaling","subsections":[]},{"section":"metrictarget-v2beta2-autoscaling","subsections":[]},{"section":"metricstatus-v2beta1-autoscaling","subsections":[]},{"section":"metricstatus-v2beta2-autoscaling","subsections":[]},{"section":"metricspec-v2beta1-autoscaling","subsections":[]},{"section":"metricspec-v2beta2-autoscaling","subsections":[]},{"section":"metricidentifier-v2beta2-autoscaling","subsections":[]},{"section":"limitedprioritylevelconfiguration-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"limitresponse-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"jobtemplatespec-v1beta1-batch","subsections":[]},{"section":"horizontalpodautoscalercondition-v2beta1-autoscaling","subsections":[]},{"section":"horizontalpodautoscalercondition-v2beta2-autoscaling","subsections":[]},{"section":"horizontalpodautoscalerbehavior-v2beta2-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":"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":"hpascalingrules-v2beta2-autoscaling","subsections":[]},{"section":"hpascalingpolicy-v2beta2-autoscaling","subsections":[]},{"section":"groupsubject-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"forzone-v1beta1-discovery-k8s-io","subsections":[]},{"section":"flowschemacondition-v1beta1-flowcontrol-apiserver-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":"flowdistinguishermethod-v1beta1-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"externalmetricstatus-v2beta1-autoscaling","subsections":[]},{"section":"externalmetricstatus-v2beta2-autoscaling","subsections":[]},{"section":"externalmetricsource-v2beta1-autoscaling","subsections":[]},{"section":"externalmetricsource-v2beta2-autoscaling","subsections":[]},{"section":"eventseries-v1beta1-events-k8s-io","subsections":[]},{"section":"eventseries-v1-core","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-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":"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":"crossversionobjectreference-v2beta1-autoscaling","subsections":[]},{"section":"crossversionobjectreference-v2beta2-autoscaling","subsections":[]},{"section":"crossversionobjectreference-v2-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":"containerresourcemetricstatus-v2beta2-autoscaling","subsections":[]},{"section":"containerresourcemetricsource-v2beta1-autoscaling","subsections":[]},{"section":"containerresourcemetricsource-v2beta2-autoscaling","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":"-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":"validationrule-v1-apiextensions-k8s-io","subsections":[]},{"section":"validatingwebhook-v1-admissionregistration-k8s-io","subsections":[]},{"section":"usersubject-v1beta2-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"userinfo-v1-authentication-k8s-io","subsections":[]},{"section":"uncountedterminatedpods-v1-batch","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-v1beta2-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":"statefulsetpersistentvolumeclaimretentionpolicy-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-v1beta2-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-v1beta2-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"resourcemetricstatus-v2-autoscaling","subsections":[]},{"section":"resourcemetricsource-v2-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-v1beta2-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"quantity-resource-core","subsections":[]},{"section":"projectedvolumesource-v1-core","subsections":[]},{"section":"probe-v1-core","subsections":[]},{"section":"prioritylevelconfigurationreference-v1beta2-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"prioritylevelconfigurationcondition-v1beta2-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"prioritylevelconfiguration-v1beta2-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-v1beta2-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"policyrule-v1-rbac-authorization-k8s-io","subsections":[]},{"section":"podsmetricstatus-v2-autoscaling","subsections":[]},{"section":"podsmetricsource-v2-autoscaling","subsections":[]},{"section":"podsecuritycontext-v1-core","subsections":[]},{"section":"podreadinessgate-v1-core","subsections":[]},{"section":"podos-v1-core","subsections":[]},{"section":"podip-v1-core","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-v2-autoscaling","subsections":[]},{"section":"objectmetricsource-v2-autoscaling","subsections":[]},{"section":"objectmeta-v1-meta","subsections":[]},{"section":"objectfieldselector-v1-core","subsections":[]},{"section":"nonresourcerule-v1-authorization-k8s-io","subsections":[]},{"section":"nonresourcepolicyrule-v1beta2-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-v2-autoscaling","subsections":[]},{"section":"metrictarget-v2-autoscaling","subsections":[]},{"section":"metricstatus-v2-autoscaling","subsections":[]},{"section":"metricspec-v2-autoscaling","subsections":[]},{"section":"metricidentifier-v2-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-v1beta2-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"limitresponse-v1beta2-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"limitrangeitem-v1-core","subsections":[]},{"section":"lifecyclehandler-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-v2-autoscaling","subsections":[]},{"section":"horizontalpodautoscalerbehavior-v2-autoscaling","subsections":[]},{"section":"horizontalpodautoscaler-v2-autoscaling","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-v2-autoscaling","subsections":[]},{"section":"hpascalingpolicy-v2-autoscaling","subsections":[]},{"section":"groupversionfordiscovery-v1-meta","subsections":[]},{"section":"groupsubject-v1beta2-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"glusterfsvolumesource-v1-core","subsections":[]},{"section":"glusterfspersistentvolumesource-v1-core","subsections":[]},{"section":"gitrepovolumesource-v1-core","subsections":[]},{"section":"grpcaction-v1-core","subsections":[]},{"section":"gcepersistentdiskvolumesource-v1-core","subsections":[]},{"section":"forzone-v1-discovery-k8s-io","subsections":[]},{"section":"flowschemacondition-v1beta2-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"flowschema-v1beta2-flowcontrol-apiserver-k8s-io","subsections":[]},{"section":"flowdistinguishermethod-v1beta2-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-v2-autoscaling","subsections":[]},{"section":"externalmetricsource-v2-autoscaling","subsections":[]},{"section":"externaldocumentation-v1-apiextensions-k8s-io","subsections":[]},{"section":"execaction-v1-core","subsections":[]},{"section":"eviction-v1-policy","subsections":[]},{"section":"eventsource-v1-core","subsections":[]},{"section":"eventseries-v1-events-k8s-io","subsections":[]},{"section":"ephemeralvolumesource-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":"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":"containerstatewaiting-v1-core","subsections":[]},{"section":"containerstateterminated-v1-core","subsections":[]},{"section":"containerstaterunning-v1-core","subsections":[]},{"section":"containerstate-v1-core","subsections":[]},{"section":"containerresourcemetricstatus-v2-autoscaling","subsections":[]},{"section":"containerresourcemetricsource-v2-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":"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-v1-policy","subsections":[{"section":"-strong-status-operations-poddisruptionbudget-v1-policy-strong-","subsections":[{"section":"replace-status-poddisruptionbudget-v1-policy","subsections":[]},{"section":"read-status-poddisruptionbudget-v1-policy","subsections":[]},{"section":"patch-status-poddisruptionbudget-v1-policy","subsections":[]}]},{"section":"-strong-read-operations-poddisruptionbudget-v1-policy-strong-","subsections":[{"section":"watch-list-all-namespaces-poddisruptionbudget-v1-policy","subsections":[]},{"section":"watch-list-poddisruptionbudget-v1-policy","subsections":[]},{"section":"watch-poddisruptionbudget-v1-policy","subsections":[]},{"section":"list-all-namespaces-poddisruptionbudget-v1-policy","subsections":[]},{"section":"list-poddisruptionbudget-v1-policy","subsections":[]},{"section":"read-poddisruptionbudget-v1-policy","subsections":[]}]},{"section":"-strong-write-operations-poddisruptionbudget-v1-policy-strong-","subsections":[{"section":"delete-collection-poddisruptionbudget-v1-policy","subsections":[]},{"section":"delete-poddisruptionbudget-v1-policy","subsections":[]},{"section":"replace-poddisruptionbudget-v1-policy","subsections":[]},{"section":"patch-poddisruptionbudget-v1-policy","subsections":[]},{"section":"create-poddisruptionbudget-v1-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-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":"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":"csistoragecapacity-v1beta1-storage-k8s-io","subsections":[{"section":"-strong-read-operations-csistoragecapacity-v1beta1-storage-k8s-io-strong-","subsections":[{"section":"watch-list-all-namespaces-csistoragecapacity-v1beta1-storage-k8s-io","subsections":[]},{"section":"watch-list-csistoragecapacity-v1beta1-storage-k8s-io","subsections":[]},{"section":"watch-csistoragecapacity-v1beta1-storage-k8s-io","subsections":[]},{"section":"list-all-namespaces-csistoragecapacity-v1beta1-storage-k8s-io","subsections":[]},{"section":"list-csistoragecapacity-v1beta1-storage-k8s-io","subsections":[]},{"section":"read-csistoragecapacity-v1beta1-storage-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-csistoragecapacity-v1beta1-storage-k8s-io-strong-","subsections":[{"section":"delete-collection-csistoragecapacity-v1beta1-storage-k8s-io","subsections":[]},{"section":"delete-csistoragecapacity-v1beta1-storage-k8s-io","subsections":[]},{"section":"replace-csistoragecapacity-v1beta1-storage-k8s-io","subsections":[]},{"section":"patch-csistoragecapacity-v1beta1-storage-k8s-io","subsections":[]},{"section":"create-csistoragecapacity-v1beta1-storage-k8s-io","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-collection-service-v1-core","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-v1-discovery-k8s-io","subsections":[{"section":"-strong-read-operations-endpointslice-v1-discovery-k8s-io-strong-","subsections":[{"section":"watch-list-all-namespaces-endpointslice-v1-discovery-k8s-io","subsections":[]},{"section":"watch-list-endpointslice-v1-discovery-k8s-io","subsections":[]},{"section":"watch-endpointslice-v1-discovery-k8s-io","subsections":[]},{"section":"list-all-namespaces-endpointslice-v1-discovery-k8s-io","subsections":[]},{"section":"list-endpointslice-v1-discovery-k8s-io","subsections":[]},{"section":"read-endpointslice-v1-discovery-k8s-io","subsections":[]}]},{"section":"-strong-write-operations-endpointslice-v1-discovery-k8s-io-strong-","subsections":[{"section":"delete-collection-endpointslice-v1-discovery-k8s-io","subsections":[]},{"section":"delete-endpointslice-v1-discovery-k8s-io","subsections":[]},{"section":"replace-endpointslice-v1-discovery-k8s-io","subsections":[]},{"section":"patch-endpointslice-v1-discovery-k8s-io","subsections":[]},{"section":"create-endpointslice-v1-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-ephemeralcontainers-operations-pod-v1-core-strong-","subsections":[{"section":"replace-ephemeralcontainers-pod-v1-core","subsections":[]},{"section":"read-ephemeralcontainers-pod-v1-core","subsections":[]},{"section":"patch-ephemeralcontainers-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-v1-batch","subsections":[{"section":"-strong-status-operations-cronjob-v1-batch-strong-","subsections":[{"section":"replace-status-cronjob-v1-batch","subsections":[]},{"section":"read-status-cronjob-v1-batch","subsections":[]},{"section":"patch-status-cronjob-v1-batch","subsections":[]}]},{"section":"-strong-read-operations-cronjob-v1-batch-strong-","subsections":[{"section":"watch-list-all-namespaces-cronjob-v1-batch","subsections":[]},{"section":"watch-list-cronjob-v1-batch","subsections":[]},{"section":"watch-cronjob-v1-batch","subsections":[]},{"section":"list-all-namespaces-cronjob-v1-batch","subsections":[]},{"section":"list-cronjob-v1-batch","subsections":[]},{"section":"read-cronjob-v1-batch","subsections":[]}]},{"section":"-strong-write-operations-cronjob-v1-batch-strong-","subsections":[{"section":"delete-collection-cronjob-v1-batch","subsections":[]},{"section":"delete-cronjob-v1-batch","subsections":[]},{"section":"replace-cronjob-v1-batch","subsections":[]},{"section":"patch-cronjob-v1-batch","subsections":[]},{"section":"create-cronjob-v1-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-v1-apiextensions-k8s-io","usersubject-v1beta1-flowcontrol-apiserver-k8s-io","tokenrequest-v1-storage-k8s-io","subject-v1beta1-flowcontrol-apiserver-k8s-io","subject-v1-rbac-authorization-k8s-io","servicereference-v1-apiregistration-k8s-io","servicereference-v1-apiextensions-k8s-io","serviceaccountsubject-v1beta1-flowcontrol-apiserver-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","resourcepolicyrule-v1beta1-flowcontrol-apiserver-k8s-io","resourcemetricstatus-v2beta1-autoscaling","resourcemetricstatus-v2beta2-autoscaling","resourcemetricsource-v2beta1-autoscaling","resourcemetricsource-v2beta2-autoscaling","queuingconfiguration-v1beta1-flowcontrol-apiserver-k8s-io","prioritylevelconfigurationreference-v1beta1-flowcontrol-apiserver-k8s-io","prioritylevelconfigurationcondition-v1beta1-flowcontrol-apiserver-k8s-io","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","policyruleswithsubjects-v1beta1-flowcontrol-apiserver-k8s-io","podsmetricstatus-v2beta1-autoscaling","podsmetricstatus-v2beta2-autoscaling","podsmetricsource-v2beta1-autoscaling","podsmetricsource-v2beta2-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","objectmetricstatus-v2beta2-autoscaling","objectmetricsource-v2beta1-autoscaling","objectmetricsource-v2beta2-autoscaling","nonresourcepolicyrule-v1beta1-flowcontrol-apiserver-k8s-io","metricvaluestatus-v2beta2-autoscaling","metrictarget-v2beta2-autoscaling","metricstatus-v2beta1-autoscaling","metricstatus-v2beta2-autoscaling","metricspec-v2beta1-autoscaling","metricspec-v2beta2-autoscaling","metricidentifier-v2beta2-autoscaling","limitedprioritylevelconfiguration-v1beta1-flowcontrol-apiserver-k8s-io","limitresponse-v1beta1-flowcontrol-apiserver-k8s-io","jobtemplatespec-v1beta1-batch","horizontalpodautoscalercondition-v2beta1-autoscaling","horizontalpodautoscalercondition-v2beta2-autoscaling","horizontalpodautoscalerbehavior-v2beta2-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","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","hpascalingrules-v2beta2-autoscaling","hpascalingpolicy-v2beta2-autoscaling","groupsubject-v1beta1-flowcontrol-apiserver-k8s-io","forzone-v1beta1-discovery-k8s-io","flowschemacondition-v1beta1-flowcontrol-apiserver-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","flowdistinguishermethod-v1beta1-flowcontrol-apiserver-k8s-io","externalmetricstatus-v2beta1-autoscaling","externalmetricstatus-v2beta2-autoscaling","externalmetricsource-v2beta1-autoscaling","externalmetricsource-v2beta2-autoscaling","eventseries-v1beta1-events-k8s-io","eventseries-v1-core","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-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","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","crossversionobjectreference-v2beta1-autoscaling","crossversionobjectreference-v2beta2-autoscaling","crossversionobjectreference-v2-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","containerresourcemetricstatus-v2beta2-autoscaling","containerresourcemetricsource-v2beta1-autoscaling","containerresourcemetricsource-v2beta2-autoscaling","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","-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","validationrule-v1-apiextensions-k8s-io","validatingwebhook-v1-admissionregistration-k8s-io","usersubject-v1beta2-flowcontrol-apiserver-k8s-io","userinfo-v1-authentication-k8s-io","uncountedterminatedpods-v1-batch","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-v1beta2-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","statefulsetpersistentvolumeclaimretentionpolicy-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-v1beta2-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-v1beta2-flowcontrol-apiserver-k8s-io","resourcemetricstatus-v2-autoscaling","resourcemetricsource-v2-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-v1beta2-flowcontrol-apiserver-k8s-io","quantity-resource-core","projectedvolumesource-v1-core","probe-v1-core","prioritylevelconfigurationreference-v1beta2-flowcontrol-apiserver-k8s-io","prioritylevelconfigurationcondition-v1beta2-flowcontrol-apiserver-k8s-io","prioritylevelconfiguration-v1beta2-flowcontrol-apiserver-k8s-io","preferredschedulingterm-v1-core","preconditions-v1-meta","portworxvolumesource-v1-core","portstatus-v1-core","policyruleswithsubjects-v1beta2-flowcontrol-apiserver-k8s-io","policyrule-v1-rbac-authorization-k8s-io","podsmetricstatus-v2-autoscaling","podsmetricsource-v2-autoscaling","podsecuritycontext-v1-core","podreadinessgate-v1-core","podos-v1-core","podip-v1-core","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-v2-autoscaling","objectmetricsource-v2-autoscaling","objectmeta-v1-meta","objectfieldselector-v1-core","nonresourcerule-v1-authorization-k8s-io","nonresourcepolicyrule-v1beta2-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-v2-autoscaling","metrictarget-v2-autoscaling","metricstatus-v2-autoscaling","metricspec-v2-autoscaling","metricidentifier-v2-autoscaling","managedfieldsentry-v1-meta","localvolumesource-v1-core","localobjectreference-v1-core","loadbalancerstatus-v1-core","loadbalanceringress-v1-core","listmeta-v1-meta","limitedprioritylevelconfiguration-v1beta2-flowcontrol-apiserver-k8s-io","limitresponse-v1beta2-flowcontrol-apiserver-k8s-io","limitrangeitem-v1-core","lifecyclehandler-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-v2-autoscaling","horizontalpodautoscalerbehavior-v2-autoscaling","horizontalpodautoscaler-v2-autoscaling","httpingressrulevalue-v1-networking-k8s-io","httpingresspath-v1-networking-k8s-io","httpheader-v1-core","httpgetaction-v1-core","hpascalingrules-v2-autoscaling","hpascalingpolicy-v2-autoscaling","groupversionfordiscovery-v1-meta","groupsubject-v1beta2-flowcontrol-apiserver-k8s-io","glusterfsvolumesource-v1-core","glusterfspersistentvolumesource-v1-core","gitrepovolumesource-v1-core","grpcaction-v1-core","gcepersistentdiskvolumesource-v1-core","forzone-v1-discovery-k8s-io","flowschemacondition-v1beta2-flowcontrol-apiserver-k8s-io","flowschema-v1beta2-flowcontrol-apiserver-k8s-io","flowdistinguishermethod-v1beta2-flowcontrol-apiserver-k8s-io","flockervolumesource-v1-core","flexvolumesource-v1-core","flexpersistentvolumesource-v1-core","fieldsv1-v1-meta","fsgroupstrategyoptions-v1beta1-policy","fcvolumesource-v1-core","externalmetricstatus-v2-autoscaling","externalmetricsource-v2-autoscaling","externaldocumentation-v1-apiextensions-k8s-io","execaction-v1-core","eviction-v1-policy","eventsource-v1-core","eventseries-v1-events-k8s-io","ephemeralvolumesource-v1-core","ephemeralcontainer-v1-core","envvarsource-v1-core","envvar-v1-core","envfromsource-v1-core","endpointsubset-v1-core","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","containerstatewaiting-v1-core","containerstateterminated-v1-core","containerstaterunning-v1-core","containerstate-v1-core","containerresourcemetricstatus-v2-autoscaling","containerresourcemetricsource-v2-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","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-v1-policy","read-status-poddisruptionbudget-v1-policy","patch-status-poddisruptionbudget-v1-policy","-strong-status-operations-poddisruptionbudget-v1-policy-strong-","watch-list-all-namespaces-poddisruptionbudget-v1-policy","watch-list-poddisruptionbudget-v1-policy","watch-poddisruptionbudget-v1-policy","list-all-namespaces-poddisruptionbudget-v1-policy","list-poddisruptionbudget-v1-policy","read-poddisruptionbudget-v1-policy","-strong-read-operations-poddisruptionbudget-v1-policy-strong-","delete-collection-poddisruptionbudget-v1-policy","delete-poddisruptionbudget-v1-policy","replace-poddisruptionbudget-v1-policy","patch-poddisruptionbudget-v1-policy","create-poddisruptionbudget-v1-policy","-strong-write-operations-poddisruptionbudget-v1-policy-strong-","poddisruptionbudget-v1-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-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","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-all-namespaces-csistoragecapacity-v1beta1-storage-k8s-io","watch-list-csistoragecapacity-v1beta1-storage-k8s-io","watch-csistoragecapacity-v1beta1-storage-k8s-io","list-all-namespaces-csistoragecapacity-v1beta1-storage-k8s-io","list-csistoragecapacity-v1beta1-storage-k8s-io","read-csistoragecapacity-v1beta1-storage-k8s-io","-strong-read-operations-csistoragecapacity-v1beta1-storage-k8s-io-strong-","delete-collection-csistoragecapacity-v1beta1-storage-k8s-io","delete-csistoragecapacity-v1beta1-storage-k8s-io","replace-csistoragecapacity-v1beta1-storage-k8s-io","patch-csistoragecapacity-v1beta1-storage-k8s-io","create-csistoragecapacity-v1beta1-storage-k8s-io","-strong-write-operations-csistoragecapacity-v1beta1-storage-k8s-io-strong-","csistoragecapacity-v1beta1-storage-k8s-io","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-collection-service-v1-core","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-v1-discovery-k8s-io","watch-list-endpointslice-v1-discovery-k8s-io","watch-endpointslice-v1-discovery-k8s-io","list-all-namespaces-endpointslice-v1-discovery-k8s-io","list-endpointslice-v1-discovery-k8s-io","read-endpointslice-v1-discovery-k8s-io","-strong-read-operations-endpointslice-v1-discovery-k8s-io-strong-","delete-collection-endpointslice-v1-discovery-k8s-io","delete-endpointslice-v1-discovery-k8s-io","replace-endpointslice-v1-discovery-k8s-io","patch-endpointslice-v1-discovery-k8s-io","create-endpointslice-v1-discovery-k8s-io","-strong-write-operations-endpointslice-v1-discovery-k8s-io-strong-","endpointslice-v1-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-ephemeralcontainers-pod-v1-core","read-ephemeralcontainers-pod-v1-core","patch-ephemeralcontainers-pod-v1-core","-strong-ephemeralcontainers-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-v1-batch","read-status-cronjob-v1-batch","patch-status-cronjob-v1-batch","-strong-status-operations-cronjob-v1-batch-strong-","watch-list-all-namespaces-cronjob-v1-batch","watch-list-cronjob-v1-batch","watch-cronjob-v1-batch","list-all-namespaces-cronjob-v1-batch","list-cronjob-v1-batch","read-cronjob-v1-batch","-strong-read-operations-cronjob-v1-batch-strong-","delete-collection-cronjob-v1-batch","delete-cronjob-v1-batch","replace-cronjob-v1-batch","patch-cronjob-v1-batch","create-cronjob-v1-batch","-strong-write-operations-cronjob-v1-batch-strong-","cronjob-v1-batch","container-v1-core","-strong-workloads-apis-strong-","-strong-api-groups-strong-","-strong-api-overview-strong-"]};})(); \ No newline at end of file